public class ContractSuspendCmdImpl extends com.ibm.commerce.command.ControllerCommandImpl implements ContractSuspendCmd
ContractSuspendCmd
controller command.
Name | Description |
---|---|
ContractId |
The ID of the contract. Mandatory. |
RequestProperties |
The request properties.Possible values include: redirecturl, contractId, accountId. Mandatory. |
Name | Description |
---|---|
ContractId |
The ID of the contract. |
Resources |
the access vector accessed by this command |
ManageStoreCmd
UpdateStoreRelationshipStateCmd
UpdateRegistryCmd
ContractAccessBean
TradingAgreementAccessBean
com.ibm.commerce.common.objects.StoreJDBCHelperAccessBean#findStoresCreatedByContract(java.lang.Long)
com.ibm.commerce.contract.objects.ContractJDBCHelperAccessBean#findStoreIdsInStoreContractByContractId(java.lang.Long)
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASSNAME
The name of the default implementation.
|
static java.lang.String |
COPYRIGHT
IBM copyright notice field.
|
defaultCommandClassName, NAME
Constructor and Description |
---|
ContractSuspendCmdImpl() |
Modifier and Type | Method and Description |
---|---|
java.lang.Long |
getContractId()
Gets the id of the suspended contract.
|
com.ibm.commerce.accesscontrol.AccessVector |
getResources()
Gets the access vector accessed by this command.
|
void |
performExecute()
Executes the business logic of this command implementation.
|
void |
setContractId(java.lang.Long newContractId)
Sets id of the contract to be suspended.
|
void |
setRequestProperties(com.ibm.commerce.datatype.TypedProperty aRequestProperties)
Retrieves input parameters from the request properties.
|
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
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, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, 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, 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()
getContractId
in interface ContractSuspendCmd
public com.ibm.commerce.accesscontrol.AccessVector getResources() throws com.ibm.commerce.exception.ECException
getResources
in interface com.ibm.commerce.command.ECCommand
getResources
in class com.ibm.commerce.command.AbstractECTargetableCommand
com.ibm.commerce.exception.ECException
AbstractECTargetableCommand.getResources()
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_UPDATE_STORE_STATUS whenever the error occurs in ManageStoreCmd. see that command for detail
Raised with message _ERR_UPDATE_STORE_RELATIONSHIP_STATE whenever the error occurs in UpdateStoreRelationshipStateCmd.
see that command for detail.
Raised with message _ERR_UPDATE_STORE_OR_STORE_RELATIONSHIP_STATE if one of the following exception be thrown when
trying to get store and store relationship information from the specified contract: CreateException, RemoteException,
SQLException, FinderException, NameException.ManageStoreCmdImpl.performExecute()
,
UpdateStoreRelationshipStateCmdImpl.performExecute()
,
ECCommand.performExecute()
,
AbstractECTargetableCommand.performExecute()
public void setContractId(java.lang.Long newContractId)
setContractId
in interface ContractSuspendCmd
newContractId
- the id of the contract to be suspendedpublic 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, contractId is required parameter.com.ibm.commerce.exception.ECApplicationException
- Raised with message _ERR_MISSING_CMD_PARAMETER when contractId is missed from the URL.
Raised with message _ERR_NUMBER_FORMAT_EXCEPTION if the contractId provided from the URL do not match its type.ControllerCommandImpl.setRequestProperties(TypedProperty)
public 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 Active 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()