com.ibm.commerce.contract.commands
Class ContractSubmitPostCancelCmdImpl

java.lang.Object
  |
  +--com.ibm.commerce.ubf.commands.BusinessFlowCmdImpl
        |
        +--com.ibm.commerce.contract.commands.ContractSubmitPostCancelCmdImpl
All Implemented Interfaces:
AccCommand, ContractSubmitPostCancelCmd, ControllerCommand, ECCommand

public class ContractSubmitPostCancelCmdImpl
extends com.ibm.commerce.ubf.commands.BusinessFlowCmdImpl
implements ContractSubmitPostCancelCmd

Cancel a contract approval process (WebSphere Commerce Business Edition only). The following AccessBean is used in this default implementation: ContractFlowEntityBean

See Also:
Serialized Form

Field Summary
static java.lang.String CLASSNAME
          The name of this command.
static java.lang.String COPYRIGHT
          IBM copyright notice field.
 
Fields inherited from interface com.ibm.commerce.contract.commands. ContractSubmitPostCancelCmd
defaultCommandClassName, NAME
 
Constructor Summary
ContractSubmitPostCancelCmdImpl()
           
 
Method Summary
 java.lang.Long getContractId()
          Returns the ID of the contract.
 java.lang.Long getEntityId()
          Returns the entity ID.
 com.ibm.commerce.ubf.beans.BusinessFlowEntityBean getEntityObject()
          Returns business flow entity bean.
 void performExecute()
          This method puts the contract into Draft state.
 void setContractId(java.lang.Long newContractId)
          Sets the ID of the contract.
 void setRequestProperties( TypedProperty aRequestProperties)
          Retrieves input parameters from the request properties.
 void setStateIdentifier(java.lang.Integer stateIndentifier)
          Sets the state identifier.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.commerce.command. ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties
 
Methods inherited from interface com.ibm.commerce.command. AccCommand
accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command. ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 

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

CLASSNAME

public static final java.lang.String CLASSNAME
The name of this command.
See Also:
Constant Field Values
Constructor Detail

ContractSubmitPostCancelCmdImpl

public ContractSubmitPostCancelCmdImpl()
Method Detail

getContractId

public java.lang.Long getContractId()
Returns the ID of the contract.
Returns:
the contract ID

getEntityId

public java.lang.Long getEntityId()
Returns the entity ID. It is the same as the contract ID.
Returns:
the entity ID

getEntityObject

public com.ibm.commerce.ubf.beans.BusinessFlowEntityBean getEntityObject()
Returns business flow entity bean. it is the ContractFlowEntityBean
Returns:
the entity object

performExecute

public void performExecute()
                    throws ECException
This method puts the contract into Draft state.
Specified by:
performExecute in interface ECCommand
Throws:
ECException - Raised with message _ERR_CONTRACT_CMD_EXEC if an error occurred when the command trys to change the state of the contract.
See Also:
AbstractECTargetableCommand.performExecute()

setContractId

public void setContractId(java.lang.Long newContractId)
Sets the ID of the contract.
Specified by:
setContractId in interface ContractSubmitPostCancelCmd
Parameters:
newContractId - the contract ID

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECApplicationException
Retrieves input parameters from the request properties.
Specified by:
setRequestProperties in interface ControllerCommand
Parameters:
aRequestProperties - An TypedProperty object contains the input parameters. For this default implementation, entityId is the required parameter.
Throws:
ECApplicationException - Raised with message _ERR_MISSING_CMD_PARAMETER if one of the three required parameters are missing. Raised with message _ERR_NUMBER_FORMAT_EXCEPTION if the provided entityId cannot be converted to Long object.
See Also:
ControllerCommandImpl.setRequestProperties(TypedProperty)

setStateIdentifier

public void setStateIdentifier(java.lang.Integer stateIndentifier)
Sets the state identifier.
Parameters:
stateIndentifier - the state identifier