com.ibm.commerce.datatype

Class CommandProperty

java.lang.Object

com.ibm.commerce.datatype.CommandProperty

public class CommandProperty
extends java.lang.Object

This 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 name of the command that gets executed. The execution properties include the environment variables for executing the command. The request properties are the parameters passed to the command when it is executing.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The IBM copyright notice field.

Constructor Summary

Constructors

Constructor and Description
CommandProperty() This is the default constructor for this class.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCommandName() This method returns the command name.
TypedProperty	getExecutionProperties() This method returns the execution properties.
TypedProperty	getRequestProperties() This method returns the request properties.
void	setCommandName(java.lang.String newCommandName) This method sets the command name.
void	setExecutionProperties(TypedProperty newExecutionProperties) This method sets the execution properties.
void	setRequestProperties(TypedProperty newRequestProperties) This method sets the request properties.
java.lang.String	toString() This method overrides the toString() method to return a String representation of this object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

The IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

CommandProperty

public CommandProperty()

This is the default constructor for this class. It calls the constructor from the superclass & then initializes the instance variables.

Method Detail

getCommandName

public java.lang.String getCommandName()

This method returns the command name.

Returns:

The name of the command to execute.

getExecutionProperties

public TypedProperty getExecutionProperties()

This method returns the execution properties.

Returns:

The execution properties that indicate how to execute the command. Different session context implementations look for different values stored in the execution properties.

getRequestProperties

public TypedProperty getRequestProperties()

This method 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)

This method sets the command name.

Parameters:

newCommandName - The name of the command to execute.

setExecutionProperties

public void setExecutionProperties(TypedProperty newExecutionProperties)

This method sets the execution properties.

Parameters:

newMessageProperty - The execution properties for executing the command.

setRequestProperties

public void setRequestProperties(TypedProperty newRequestProperties)

This method sets the request properties.

Parameters:

newCommandProperty - The request properties for executing the command.

toString

public java.lang.String toString()

This method overrides the toString() method to return a String representation of this object.

Overrides:

toString in class java.lang.Object

Returns:

The string representation of this object.