+Show TOC
×Hide TOC

Command

Kind of class:	public interface
Package:	com.bourre.commands
Inherits from:	none
Implemented by:	AbstractCommand Delegate EventCallbackAdapter
Known subinterfaces:	ASyncCommand DisplayObjectBuilder MacroCommand
Author:	Francis Bourre
Classpath:	com.bourre.commands.Command
File last modified:	Monday, 24 November 2008, 11:36:52

► View source

▼ Hide source

/*
 * Copyright the original author or authors.
 * 
 * Licensed under 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/MPL-1.1.html
 * 
 * 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.
 */

package com.bourre.commands 
{
    import flash.events.Event;    

    /**
     * Encapsulate a request as an object, thereby letting you parameterize
     * clients with different requests, queue or log requests, 
     * and support undoable operations.
     * <p>
     * Commands are named <strong>state-less</strong> when they can work
     * only from the passed-in event in the <code>execute</code> method without
     * having to define any parameters in the constructor.
     * </p><p>
     * Commands can be asynchronous by implementing the <code>ASyncCommand</code>
     * interface.
     * </p><p>
     * See the <a href="../../../howto/howto-commands.html">How to use the Command
     * pattern implementation in LowRA</a> document for more details on 
     * the commands package structure.
     * </p> 
     * @author     Francis Bourre
     * @see        ASyncCommand
     */
    public interface Command 
    {
        
        /**
         * Execute the request according to the current command data.
         * <p>
         * Stateless commands may use the passed-in event object
         * as data source for its execution. If the execution can't
         * be performed because of unreachable data the command have
         * to throw an error.
         * </p> 
         * @param    e    An event that will be used as data source by the command. 
         * @throws     <code>UnreachableDataException</code> ‚Äî Stateless command use the passed-in event
         *             as data source for its execution, so the event must provide the right data for
         *             the current <code>Command</code> object.
         */
        function execute( e : Event = null ) : void;
    }
}

Encapsulate a request as an object, thereby letting you parameterize
clients with different requests, queue or log requests,
and support undoable operations.

Commands are named state-less when they can work
only from the passed-in event in the execute method without
having to define any parameters in the constructor.

Commands can be asynchronous by implementing the ASyncCommandinterface.

See the How to use the Command
pattern implementation in LowRA document for more details on
the commands package structure.

Summary

Instance methods

execute (e:Event = null) : void
- Execute the request according to the current command data.

Instance methods

execute

public function execute (

e:Event = null) : void

Execute the request according to the current command data.

Stateless commands may use the passed-in event object
as data source for its execution. If the execution can't
be performed because of unreachable data the command have
to throw an error.

Parameters:

An event that will be used as data source by the command.

Throws:

{VISDOC_LINK_0}UnreachableDataException — Stateless command use the passed-in event
as data source for its execution, so the event must provide the right data for
the current Command object.