|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ICommand
Base interface for all commands. Commands are self-contained business-object units, based on the J2EE Command
Design Pattern. Typically the client code will locate the bean through the com.stellent.cis.client.command.impl.CommandFacade#getCommand
method then call the com.stellent.cis.client.command.impl.CommandFacade#getCommandExecutor
to invoke the execute()
method of the
command object.
Method Summary | |
---|---|
java.lang.Object |
clone()
Creates and returns a copy of this object. |
java.lang.Object |
execute()
Execute this command. |
java.lang.String |
getCommandName()
Get the name of this command |
ICommandExecutionContext |
getExecutionContext()
|
java.lang.String |
getMethod()
Get the method associated with this bean |
boolean |
isAsynchronous()
Determine if this command should be executed asynchronously |
boolean |
isLocalInvocation()
|
void |
setAsynchronous(boolean isAsynchronous)
Set the asynchronous flag |
void |
setCommandName(java.lang.String name)
Set the name of this command |
void |
setExecutionContext(ICommandExecutionContext executionContext)
Set the execution context. |
void |
setLocalInvocation(boolean localInvocation)
Set the flag that determines if the local or remote is executed |
void |
setMethod(java.lang.String method)
Set the method name associated with this bean |
void |
setProperty(java.lang.String name,
java.lang.Object value)
Set a generic property on this command. |
Method Detail |
---|
void setProperty(java.lang.String name, java.lang.Object value)
name
- the property namevalue
- the property valuejava.lang.String getCommandName()
void setCommandName(java.lang.String name)
name
- the command namejava.lang.String getMethod()
void setMethod(java.lang.String method)
method
- the method nameboolean isAsynchronous()
void setAsynchronous(boolean isAsynchronous)
isAsynchronous
- set to true if this command should be executed asynchronouslyvoid setLocalInvocation(boolean localInvocation)
localInvocation
- set to true if using the local interface, false otherwiseboolean isLocalInvocation()
java.lang.Object execute() throws CommandException
ICommandExecutor
interface. setExecutionContext(ICommandExecutionContext)
before calling this method.
CommandException
ICommandExecutionContext getExecutionContext()
void setExecutionContext(ICommandExecutionContext executionContext)
executionContext
- Must be present before calling execute()
java.lang.Object clone() throws java.lang.CloneNotSupportedException
- Returns:
- a clone of this instance.
- Throws:
java.lang.CloneNotSupportedException
- if the object's class does not support theCloneable
interface. Subclasses that override theclone
method can also throw this exception to indicate that an instance cannot be cloned.java.lang.OutOfMemoryError
- if there is not enough memory.- See Also:
Cloneable
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |