com.ibm.commerce.contract.commands
Class ContractResumeCmdImpl
- 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.contract.commands.ContractResumeCmdImpl
-
- All Implemented Interfaces:
- com.ibm.commerce.command.AccCommand, com.ibm.commerce.command.ControllerCommand, com.ibm.commerce.command.ECCommand, com.ibm.commerce.command.ECTargetableCommand, ContractResumeCmd, com.ibm.commerce.security.Protectable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command
public class ContractResumeCmdImpl extends com.ibm.commerce.command.ControllerCommandImpl implements ContractResumeCmd
This is the default implementation of theContractResumeCmd
controller command.Input parameters:
ContractId
The id of the specified contract. Mandatory. RequestProperties
The request properties.Possible include: accountId, redirecturl. Optional. Behaviour:
-
Resumes the specified contract to Active state (WebSphere
Commerce Enterprise only). The specified contract has
to be in Suspended state.
Closes the specified contract. If there is a store created by this contract. For Distributor store, the status of the store will be set to "Open". For Hosting store, the status of the store will be set to "Close". The state of the store relationship if it has will be set to "Active".
AccessBeans used:
ContractAccessBean
TradingAgreementAccessBean
com.ibm.commerce.common.objects.StoreJDBCHelperAccessBean#findStoresCreatedByContract(java.lang.Long)
com.ibm.commerce.contract.objects.ContractJDBCHelperAccessBean#findStoreIdsInStoreContractByContractId(java.lang.Long)
-
-
Field Summary
Fields 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.-
Fields inherited from interface com.ibm.commerce.contract.commands.ContractResumeCmd
defaultCommandClassName, NAME
-
-
Constructor Summary
Constructors Constructor and Description ContractResumeCmdImpl()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description java.lang.Long
getContractId()
Gets the id of the resumed 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 contractId)
Sets id of the contract to be resumed.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.-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
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, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
-
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, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
-
-
-
-
Field Detail
-
CLASSNAME
public static final java.lang.String CLASSNAME
The name of the default implementation.- See Also:
- Constant Field Values
-
COPYRIGHT
public static final java.lang.String COPYRIGHT
IBM copyright notice field.- See Also:
- Constant Field Values
-
-
Method Detail
-
getContractId
public java.lang.Long getContractId()
Gets the id of the resumed contract.- Specified by:
getContractId
in interfaceContractResumeCmd
- Returns:
- the id of the resumed contract
-
getResources
public com.ibm.commerce.accesscontrol.AccessVector getResources() throws com.ibm.commerce.exception.ECException
Gets the access vector accessed by this command. The default implementation returns ContractAccessBean of contract to be resumed.- Specified by:
getResources
in interfacecom.ibm.commerce.command.ECCommand
- Overrides:
getResources
in classcom.ibm.commerce.command.AbstractECTargetableCommand
- Returns:
- AccessVector - a vector of resource action pairs
- Throws:
com.ibm.commerce.exception.ECException
- See Also:
AbstractECTargetableCommand.getResources()
-
performExecute
public void performExecute() throws com.ibm.commerce.exception.ECException
Executes the business logic of this command implementation.- Specified by:
performExecute
in interfacecom.ibm.commerce.command.ECCommand
- Overrides:
performExecute
in classcom.ibm.commerce.command.AbstractECTargetableCommand
- Throws:
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.- See Also:
ManageStoreCmdImpl.performExecute()
,UpdateStoreRelationshipStateCmdImpl.performExecute()
,ECCommand.performExecute()
,AbstractECTargetableCommand.performExecute()
-
setContractId
public void setContractId(java.lang.Long contractId)
Sets id of the contract to be resumed.- Specified by:
setContractId
in interfaceContractResumeCmd
- Parameters:
contractId
- the id of the contract to be resumed
-
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 interfacecom.ibm.commerce.command.ControllerCommand
- Overrides:
setRequestProperties
in classcom.ibm.commerce.command.ControllerCommandImpl
- Parameters:
aRequestProperties
- An TypedProperty object contains the input parameters. For this default implementation, contractId is required parameter.- Throws:
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.- See Also:
ControllerCommandImpl.setRequestProperties(TypedProperty)
-
validateParameters
public void validateParameters() throws com.ibm.commerce.exception.ECException
Validates the contract to check if it is in right state for this process.- Specified by:
validateParameters
in interfacecom.ibm.commerce.command.ECCommand
- Overrides:
validateParameters
in classcom.ibm.commerce.command.AbstractECTargetableCommand
- Throws:
com.ibm.commerce.exception.ECException
- Raised with message _ERR_WRONG_CONTRACT_STATE if the contract is not Suspended state. Raised with message _ERR_CONTRACT_OBJECT_NOT_FOUND if the contract cannot be found. It is based on the provided contract id.- See Also:
AbstractECTargetableCommand.validateParameters()
-
-