Packagecom.adobe.cairngorm.commands
Interfacepublic interface ICommand
SubinterfacesCommand
ImplementorsSequenceCommand

The ICommand interface enforces the contract between the Front Controller and concrete command classes in your application.

In a Cairngorm application, the application specific Front Controller will listen for events of interest, dispatching control to appropriate command classes according to the type of the event broadcast.

When an event is broadcasted by the Front Controller, it will lookup its list of registered commands, to find the command capable of carrying out the appropriate work in response to the user gesture that has caused the event.

When the event that an command is registered against is broadcast, the Front Controller class will invoke the command by calling its execute() method, which can be considered the entry point to a command.

See also

com.adobe.cairngorm.control.FrontController
com.adobe.cairngorm.control.CairngormEventDispatcher


Public Methods
 MethodDefined by
  
execute(event:CairngormEvent):void
Called by the Front Controller to execute the command.
ICommand
Method detail
execute()method
public function execute(event:CairngormEvent):void

Called by the Front Controller to execute the command.

The single entry point into an ICommand, the execute() method is called by the Front Controller when a user-gesture indicates that the user wishes to perform a task for which a particularconcrete command class has been provided.

Parameters
event:CairngormEvent — When the Front Controller receives notification of a user gesture, the Event that it receives contains both the type of the event (indicating which command should handle the work) but also any data associated with the event.

For instance, if a "login" event has been broadcasted, to which the controller has registered the LoginCommand, the event may also contain some associated data, such as the number of prior attempts at login have been made already. In this case, the event.type would be set to "login" while other properties define in the custom login event object would contain (by way of example) an attribute such as attemptedLogins.

By careful use of custom event objects, the same concrete command class is capable of responding in slightly different ways to similar user gesture requests.