/*-----------------------------------------------------------------------------
	The contents of this file are subject to the Mozilla Public License
	Version 1.1 (the "License"); you may not use this file except in
	compliance with the License. You may obtain a copy of the License at
	http://www.mozilla.org/MPL/
	
	Software distributed under the License is distributed on an "AS IS"
	basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
	License for the specific language governing rights and limitations
	under the License.
	
	The Original Code is Fever Framework code.
	
	The Initial Developer of the Original Code is Romain Ecarnot.
	Portions created by Initial Developer are Copyright (C) 2006
	the Initial Developer. All Rights Reserved.
	
	Contributor(s):
	
	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	See the License for the specific language governing permissions and
	limitations under the License.
-----------------------------------------------------------------------------*/

import com.bourre.events.IEvent;
import com.bourre.events.StringEvent;
import com.bourre.remoting.BasicFaultEvent;
import com.bourre.remoting.BasicResultEvent;

import fever.exception.IllegalAccessException;
import fever.remoting.PendingRemoteCommand;
import fever.remoting.RemotingEventController;
import fever.remoting.RemotingEventList;

/**
 * Abstract remoting command defines behaviour for <strong>AMF.onFault()</strong> 
 * result.
 *
 * @author Romain Ecarnot
 */
class fever.remoting.AMFCommand extends PendingRemoteCommand
{
	//-------------------------------------------------------------------------
	// Public API
	//-------------------------------------------------------------------------
	
	/**
	 * Executes current command process.
	 * 
	 * <p>Must be override by concrete sub command class.
	 * @throws {@link fever.exception.IllegalAccessException} if sub command class 
	 * don't override this method.
	 */
	public function execute( e : IEvent) : Void
	{
		throw new IllegalAccessException( ".execute() must be override by concrete command" );
	}
	
	/**
	 * Triggered when result is sent back from AMF service.
	 * 
	 * <p>Must be override by concrete sub command class.
	 * @throws {@link fever.exception.IllegalAccessException} if sub command class 
	 * don't override this method.
	 */
	public function onResult( e : BasicResultEvent ) : Void
	{
		throw new IllegalAccessException( ".onResult() must be override by concrete command" );
	}
	
	/**
	 * Triggered when error occures in AMF service processing. 
	 * 
	 * <p>Uses the {link fever.remoting.RemotingEventController} to dispatch 
	 * a system event.
	 */
	public function onFault( e : BasicFaultEvent ) : Void
	{
		RemotingEventController.getInstance().broadcastEvent( 
			new StringEvent( RemotingEventList.AMF_ERROR, e.getDescription()) 
		);
	}
	
	
	//-------------------------------------------------------------------------
	// Private implementation
	//-------------------------------------------------------------------------
	
	/** Constructor. */
	private function AMFCommand() {	}
}