+Show TOC
×Hide TOC

ASyncCommand

Kind of class:	public interface
Package:	com.bourre.commands
Inherits from:	Command
Implemented by:	AbstractLoader AbstractSyncCommand ASyncCommandSequencer
Known subinterfaces:	Loader Service
Author:	Francis Bourre
Classpath:	com.bourre.commands.ASyncCommand
File last modified:	Wednesday, 23 January 2008, 14:47:59

► 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
{

    /**
     * An asynchronous command is a runnable command, which is not terminated
     * at the end of the <code>execute</code> call, for example a remoting request,
     * or a file loading.
     * <p>
     * An asynchronous command define a specific ending for the operation. The 
     * command dispatch an <code>onCommandEnd</code> event at the end of its process.
     * </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        Command
     * @see        Runnable
     */
    public interface ASyncCommand extends Command, Runnable
    {
        /**
         * Adds the passed-in command listener object as listener
         * for this command events.
         * <p>
         * The <code>addASyncCommandListener</code> function support
         * the custom arguments provided by the 
         * <code>EventBroadcaster.addEventListener()</code> method.
         * </p> 
         * @param    listener    the listener object which want to
         *                         receive notification from this command
         * @param    rest        optional arguments corresponding to the 
         *                         <code>EventBroadcaster.addEventListener()</code>
         *                         behavior.
         * @return    <code>true</code> if the listener have been added as result
         *             of the call    
         * @see        com.bourre.events.EventBroadcaster#addEventListener()
         *             EventBroadcaster.addEventListener() documentation
         */
        function addASyncCommandListener( listener : ASyncCommandListener, ... rest ) : Boolean;
        
        /**
         * Removes the passed-in command listener object as listener
         * for this command events.
         * 
         * @param    listener    the listener object which to remove from this
         *                         command's listeners
         * @return    <code>true</code> if the listener have been removed as result
         *             of the call    
         * @see        com.bourre.events.EventBroadcaster#addEventListener()
         *             EventBroadcaster.addEventListener() documentation
         */
        function removeASyncCommandListener( listener : ASyncCommandListener ) : Boolean;
        
        /**
         * Fires the <code>onCommandEnd</code> event to the listeners of this command. 
         */
        function fireCommandEndEvent() : void;
    }
}

An asynchronous command is a runnable command, which is not terminated
at the end of the execute call, for example a remoting request,
or a file loading.

An asynchronous command define a specific ending for the operation. The
command dispatch an onCommandEnd event at the end of its process.

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

Summary

Instance methods

addASyncCommandListener (listener:ASyncCommandListener, rest) : Boolean
- Adds the passed-in command listener object as listener
removeASyncCommandListener (listener:ASyncCommandListener) : Boolean
- Removes the passed-in command listener object as listener
fireCommandEndEvent : void
- Fires the onCommandEnd event to the listeners of this command.

Instance methods inherited from Command

execute

Instance methods

addASyncCommandListener

public function addASyncCommandListener (

listener:ASyncCommandListener, rest) : Boolean

Adds the passed-in command listener object as listener
for this command events.

The addASyncCommandListener function support
the custom arguments provided by the

EventBroadcaster.addEventListener() method.

Parameters:

listener:

the listener object which want to
receive notification from this command

rest :

optional arguments corresponding to the
EventBroadcaster.addEventListener() behavior.

Returns:

true if the listener have been added as result
of the call

fireCommandEndEvent

public function fireCommandEndEvent (

) : void

Fires the onCommandEnd event to the listeners of this command.

removeASyncCommandListener

public function removeASyncCommandListener (

listener:ASyncCommandListener) : Boolean

Removes the passed-in command listener object as listener
for this command events.

Parameters:

listener:

the listener object which to remove from this
command's listeners

Returns:

true if the listener have been removed as result
of the call