java.lang.Object | +--CacheableCommandImpl | +--com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.ControllerCommandImpl | +--com.ibm.commerce.contract.commands.ParticipantAddCmdImpl
Add a participant to either a trading agreement (Contract/Account) or a Contract terms and conditions (WebSphere Commerce Business Edition only). The following AccessBeans are used in this default implementation: ContractAccessBean, AccountAccessBean, TradingAgreementAccessBean, ParticipantAccessBean.
Field Summary | |
---|---|
static java.lang.String |
CLASSNAME The name of this class. |
static java.lang.String |
COPYRIGHT IBM copyright notice field. |
Fields inherited from class com.ibm.commerce.command. ControllerCommandImpl |
requestProperties,
responseProperties,
retriable,
viewReqProperties |
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
commandContext |
Fields inherited from interface com.ibm.commerce.contract.commands. ParticipantAddCmd |
defaultCommandClassName,
NAME |
Constructor Summary | |
---|---|
ParticipantAddCmdImpl() Constructor for ParticipantAddCmdImpl. |
Method Summary | |
---|---|
AccessVector |
getResources() Gets the access vector accessed by this command. |
void |
performExecute() Adds the participant to the specified contract/account or a contract terms and condtions. |
void |
setInfo(java.lang.String info) Sets information of the participant |
void |
setMemberId(java.lang.Long memberId) Sets member ID of the participant. |
void |
setRequestProperties(
TypedProperty aRequestProperties) Retrieves input parameters from the request properties. |
void |
setRole(java.lang.String role) Sets the role type of the participant. |
void |
setTcId(java.lang.Long tcId) Sets ID of the term and condition to which the participant will be added |
void |
setTermConditionId(java.lang.Long tcId) Deprecated. |
void |
setTradingId(java.lang.Long tradingId) Sets ID of the trading agreement to which the participant will be added |
void |
validateParameters() Checks the input parameters. |
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,
checkParameters,
checkResourcePermission,
createCommandExecutionEvent,
execute,
finalize,
getAccCheck,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getStoreId,
getUser,
getUserId,
isReadyToCallExecute,
reset,
setAccCheck,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Methods inherited from class java.lang.Object |
clone, equals, 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,
getStoreId,
getUser,
getUserId,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
public static final java.lang.String CLASSNAME
Constructor Detail |
---|
public ParticipantAddCmdImpl()
Method Detail |
---|
public AccessVector getResources() throws ECException
getResources
in interface
ECCommand
getResources
in class
AbstractECTargetableCommand
ECException
AbstratECTargetableCommand#getResources()
public void performExecute() throws ECException
performExecute
in interface
ECCommand
performExecute
in class
AbstractECTargetableCommand
ECException
AbstractECTargetableCommand.performExecute()
public void setInfo(java.lang.String info)
setInfo
in interface
ParticipantAddCmd
info
- a string of information for the
participantpublic void setMemberId(java.lang.Long memberId)
setMemberId
in interface
ParticipantAddCmd
memberId
- the member ID of the
participantpublic void setRequestProperties(TypedProperty aRequestProperties) throws ECApplicationException
setRequestProperties
in interface
ControllerCommand
setRequestProperties
in class
ControllerCommandImpl
aRequestProperties
- An TypedProperty object contains the
input parameters. For this default implementation, memberId and role are
required parameters. optional parameters are info, id, tcId. In the case to add
a participant to an account/contract, the account/contract ID has to be
provided through the parameter id. In the case to add participant to a term and
condition of a contract, the ID of the term and condition has to be provided
through the parameter tcId.
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 id, tcId
cannot be converted to Long object.ControllerCommandImpl.setRequestProperties(TypedProperty)
public void setRole(java.lang.String role)
setRole
in interface
ParticipantAddCmd
role
- the type of the participant rolepublic void setTcId(java.lang.Long tcId)
setTcId
in interface
ParticipantAddCmd
tcId
- term condition IDpublic void setTermConditionId(java.lang.Long tcId)
tcId
- term condition IDpublic void setTradingId(java.lang.Long tradingId)
setTradingId
in interface
ParticipantAddCmd
tradingId
- the trading agreement IDpublic void validateParameters() throws ECException
validateParameters
in interface
ECCommand
validateParameters
in class
AbstractECTargetableCommand
ECException
- Raised with message _ERR_PARTICIPANT_ADD_TARGET_ID if both the id and tcId
parameters are missing or provided at the same time for this command. Raised
with message _ERR_PARTICIPANT_ROLE_TYPE_DO_NOT_EXIST if the role type provided
is not a supported role type. Raised with message _ERR_ACCOUNT_TC_PARTICIPANT
whenever trying to add a participant to an Business Account terms and
conditions. Raised with message _ERR_WRONG_CONTRACT_STATE if the contract do
not in Draft or Rejected state when adding a participant to a contract or a
contract terms and conditions.AbstractECTargetableCommand.validateParameters()