public class ContractSubmitPreApprovalCmdImpl extends BusinessFlowCmdImpl implements ContractSubmitPostApprovalCmd
ContractSubmitPreApprovalCmd
controller command.
Name | Description |
---|---|
ContractId |
The ID of the contract. Mandatory. |
StateIdentifier |
The state identifier. Optional. |
RequestProperties |
The request properties.Possible values include: redirecturl, storeId. Mandatory. |
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. |
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.
|
defaultCommandClassName, NAME
Constructor and Description |
---|
ContractSubmitPreApprovalCmdImpl() |
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()
Executes the business logic of this command implementation.
|
void |
setContractId(java.lang.Long contractId)
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.
|
void |
validateParameters()
Validates the contract to check if it is in right state for this process.
|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getFlowContext, getStateIdentifier, isReadyToCallExecute, reset, setEntityId, setEntityObject, setFlowContext
checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties
accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties
accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
public static final java.lang.String CLASSNAME
public static final java.lang.String COPYRIGHT
public java.lang.Long getContractId()
public java.lang.Long getEntityId()
getEntityId
in interface BusinessFlowCmd
getEntityId
in class BusinessFlowCmdImpl
public BusinessFlowEntityBean getEntityObject()
getEntityObject
in interface BusinessFlowCmd
getEntityObject
in class BusinessFlowCmdImpl
public void performExecute() throws com.ibm.commerce.exception.ECException
performExecute
in interface com.ibm.commerce.command.ECCommand
performExecute
in class com.ibm.commerce.command.AbstractECTargetableCommand
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.ECCommand.performExecute()
,
AbstractECTargetableCommand.performExecute()
public void setContractId(java.lang.Long contractId)
setContractId
in interface ContractSubmitPostApprovalCmd
contractId
- the contract IDpublic void setRequestProperties(com.ibm.commerce.datatype.TypedProperty aRequestProperties) throws com.ibm.commerce.exception.ECApplicationException
setRequestProperties
in interface com.ibm.commerce.command.ControllerCommand
setRequestProperties
in class com.ibm.commerce.command.ControllerCommandImpl
aRequestProperties
- An TypedProperty object contains the input parameters.
For this default implementation, storeId and contractId are the required parameters.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 contractId, storeId cannot
be converted to Long, Integer object.ControllerCommandImpl.setRequestProperties(TypedProperty)
public void setStateIdentifier(java.lang.Integer stateIndentifier)
setStateIdentifier
in interface BusinessFlowCmd
setStateIdentifier
in class BusinessFlowCmdImpl
stateIndentifier
- the state identifierpublic void validateParameters() throws com.ibm.commerce.exception.ECException
validateParameters
in interface com.ibm.commerce.command.ECCommand
validateParameters
in class com.ibm.commerce.command.AbstractECTargetableCommand
com.ibm.commerce.exception.ECException
- Raised with message _ERR_WRONG_CONTRACT_STATE if the contract is not in Draft state.
Raised with message _ERR_CONTRACT_OBJECT_NOT_FOUND if the contract cannot be found. It is based on the provided contract id.AbstractECTargetableCommand.validateParameters()