com.ibm.commerce.contract.commands

Class ContractSubmitPostCancelCmdImpl

java.lang.Object

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.ControllerCommandImpl

com.ibm.commerce.ubf.commands.BusinessFlowCmdImpl

com.ibm.commerce.contract.commands.ContractSubmitPostCancelCmdImpl

All Implemented Interfaces:

com.ibm.commerce.command.AccCommand, com.ibm.commerce.command.ControllerCommand, com.ibm.commerce.command.ECCommand, com.ibm.commerce.command.ECTargetableCommand, ContractSubmitPostCancelCmd, com.ibm.commerce.security.Protectable, BusinessFlowCmd, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command

public class ContractSubmitPostCancelCmdImpl
extends BusinessFlowCmdImpl
implements ContractSubmitPostCancelCmd

This is the default implementation of the ContractSubmitPostCancelCmd controller command.

Input parameters:

Name	Description
ContractId	The ID of the contract. Mandatory.
StateIdentifier	The state identifier. Optional.
RequestProperties	The request properties.Possible values include: redirecturl, storeId. Mandatory.

Output parameters:

Name	Description
ContractId	The ID of the contract.
entityId	The entity ID.It is the same as the contract ID.
EntityObject	The business flow entity bean. It is the ContractFlowEntityBean.

Behaviour:

Cancel a contract approval process (WebSphere Commerce Enterprise only).

AccessBean called:

• ContractFlowEntityBean

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
ContractSubmitPostCancelCmdImpl()

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getContractId() Returns the ID of the contract.
java.lang.Long	getEntityId() Returns the entity ID.
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(com.ibm.commerce.datatype.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

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

Methods inherited from class com.ibm.commerce.ubf.commands.BusinessFlowCmdImpl

getFlowContext, getStateIdentifier, isReadyToCallExecute, reset, setEntityId, setEntityObject, setFlowContext

Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl

checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

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, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Methods inherited from interface com.ibm.commerce.security.Protectable

fulfills, getOwner

Field Detail

CLASSNAME

public static final java.lang.String CLASSNAME

The name of this command.

See Also:

Constant Field Values

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

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.

Specified by:

getEntityId in interface BusinessFlowCmd

Overrides:

getEntityId in class BusinessFlowCmdImpl

Returns:

the entity ID

getEntityObject

public BusinessFlowEntityBean getEntityObject()

Returns business flow entity bean. It is the ContractFlowEntityBean

Specified by:

getEntityObject in interface BusinessFlowCmd

Overrides:

getEntityObject in class BusinessFlowCmdImpl

Returns:

the entity object.

performExecute

public void performExecute()
                    throws com.ibm.commerce.exception.ECException

This method puts the contract into Draft state.

Specified by:

performExecute in interface com.ibm.commerce.command.ECCommand

Overrides:

performExecute in class com.ibm.commerce.command.AbstractECTargetableCommand

Throws:

com.ibm.commerce.exception.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(com.ibm.commerce.datatype.TypedProperty aRequestProperties)
                          throws com.ibm.commerce.exception.ECApplicationException

Retrieves input parameters from the request properties.

Specified by:

setRequestProperties in interface com.ibm.commerce.command.ControllerCommand

Overrides:

setRequestProperties in class com.ibm.commerce.command.ControllerCommandImpl

Parameters:

aRequestProperties - An TypedProperty object contains the input parameters. For this default implementation, entityId is the required parameter.

Throws:

com.ibm.commerce.exception.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.

Specified by:

setStateIdentifier in interface BusinessFlowCmd

Overrides:

setStateIdentifier in class BusinessFlowCmdImpl

Parameters:

stateIndentifier - the state identifier