org.openeai.afa
Interface ScheduledCommand

public interface ScheduledCommand

This is the interface that all ScheduledCommands must implement. It defines one method (execute) that they must implement. It is in this execute method that the specific business logic for the command is coded. The ScheduledApp component will execute these commands when the Schedule they are associated to is met.

Version:

3.0 - 28 January 2003

Author:

Tod Jackson (tod@openeai.org), Steve Wheat (steve@openeai.org)

See Also:

ScheduledCommandImpl, ScheduledApp

Method Summary

int	execute() The execute method that must be implemented by all ScheduledCommand implementations is where the specific business logic associated to the ScheduledCommand is implemented.
void	shutdown()

Method Detail

execute

int execute()
            throws ScheduledCommandException

The execute method that must be implemented by all ScheduledCommand implementations is where the specific business logic associated to the ScheduledCommand is implemented. The the ScheculedApp component determines that the ScheduledCommand implementation must be executed, it will call this method and the business logic associated to that ScheduledCommand will be executed.

Returns:

int generally anything other than -1 indicates success to the ScheduledApp which calls this method.

Throws:

ScheduledCommandException - if errors occur executing the business logic associated to the ScheduledCommand.

shutdown

void shutdown()
              throws ScheduledCommandException

Throws:

ScheduledCommandException