celeboss.data
Interface Command

public interface Command

This interface represents a command that is to be executed some time in future.

Version:

1.0

Author:

bevans

See Also:

CommandEngine

Method Summary

java.lang.String	getDescription(java.lang.Object param) Generate an text description of what this command will do.
int	invoke(java.lang.Object param) This method performs a action on the object.

Method Detail

getDescription

public java.lang.String getDescription(java.lang.Object param)

Generate an text description of what this command will do. The description may depend upno the execution parameter.

Parameters:

param - The object passed when this executes.

Returns:

String description.

invoke

public int invoke(java.lang.Object param)

This method performs a action on the object. THis method will require interaction with the data source and hence may take signficant duration to complete. The method returns the time of the next expected refresh operation.

Parameters:

param - Parameter specified for the command.

Returns:

The duation in seconds until this has to be refreshed. Negative or zero return will drop the itme from the refresh queue.