com.ibm.commerce.datatype
Class CommandProperty

java.lang.Object
  |
  +--com.ibm.commerce.datatype.CommandProperty

public class CommandProperty
extends java.lang.Object

CommandProperty is a representation of a WebSphere Commerce server command. It is comprised of three parts: the command name, the execution properties and the request properties. The command name is the command that gets executed, the execution properties indicates the environment variables when executing the command, and the request properties are the parameters passed to the command when it is executing.


Field Summary
static java.lang.String COPYRIGHT
          The IBM copyright notice field.
 
Constructor Summary
CommandProperty()
          Creates the command property object by initializing the command name to null, and creating empty request and command property objects.
 
Method Summary
 java.lang.String getCommandName()
          Returns the command name.
  TypedProperty getExecutionProperties()
          Returns the execution properties.
  TypedProperty getRequestProperties()
          Returns the request properties.
 void setCommandName(java.lang.String newCommandName)
          Sets the command name.
 void setExecutionProperties( TypedProperty newExecutionProperties)
          Sets the execution properties.
 void setRequestProperties( TypedProperty newRequestProperties)
          Sets the request properties.
 java.lang.String toString()
          Overrides the toString() method to reflect a string representation of this object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail
public static final java.lang.String COPYRIGHT
The IBM copyright notice field.
See Also:
Constant Field Values
Constructor Detail

CommandProperty

public CommandProperty()
Creates the command property object by initializing the command name to null, and creating empty request and command property objects.
Method Detail

getCommandName

public java.lang.String getCommandName()
Returns the command name.
Returns:
The name of the command to execute.

getExecutionProperties

public TypedProperty getExecutionProperties()
Returns the execution properties.
Returns:
The execution properties to indicate how to execute the command. Different session context implementations look for different values stored in the execution properties.

getRequestProperties

public TypedProperty getRequestProperties()
Returns the request properties.
Returns:
The request properties to pass to the command when it is executed.

setCommandName

public void setCommandName(java.lang.String newCommandName)
Sets the command name.
Parameters:
newCommandName - The name of the command to execute.

setExecutionProperties

public void setExecutionProperties(TypedProperty newExecutionProperties)
Sets the execution properties.

setRequestProperties

public void setRequestProperties(TypedProperty newRequestProperties)
Sets the request properties.

toString

public java.lang.String toString()
Overrides the toString() method to reflect a string representation of this object.
Overrides:
toString in class java.lang.Object
Returns:
The string representation of this object.