public class PolicyDescriptionUpdateCmdImpl extends com.ibm.commerce.command.ControllerCommandImpl implements PolicyDescriptionUpdateCmd
PolicyDescriptionUpdateCmd
controller command.
Name | (tools controller command only)XPath | Description |
---|---|---|
LanguageId |
The ID of language of the description. If not set, uses the language id of the commandContext. Optional. | |
PolicyDescription |
The short description of the business policy.. Mandatory. | |
PolicyId |
The ID of business policy which the description will be added to.. Mandatory. | |
PolicyLongDescription |
The long description of business policy. Optional. | |
RequestProperties |
The request properties. Possible values include: policyId, desc, longDesc, langId. Optional. |
Name | Description |
---|---|
Resources |
The access vector accessed by this command. |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
IBM copyright notice field.
|
defaultCommandClassName, NAME
Constructor and Description |
---|
PolicyDescriptionUpdateCmdImpl() |
Modifier and Type | Method and Description |
---|---|
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 |
setLanguageId(java.lang.Integer langId)
Sets ID of language of the description.
|
void |
setPolicyDescription(java.lang.String desc)
Sets the short description of the business policy.
|
void |
setPolicyId(java.lang.Long policyId)
Sets ID of business policy which the description will be added to.
|
void |
setPolicyLongDescription(java.lang.String longDesc)
Sets the long description of business policy.
|
void |
setRequestProperties(com.ibm.commerce.datatype.TypedProperty aRequestProperties)
Retrieves input parameters from the request properties.
|
void |
validateParameters()
Checks the input parameters.
|
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 COPYRIGHT
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
AbstractECTargetableCommand.performExecute()
public void setLanguageId(java.lang.Integer langId)
setLanguageId
in interface PolicyDescriptionUpdateCmd
langId
- the language ID of the descriptionpublic void setPolicyDescription(java.lang.String desc)
setPolicyDescription
in interface PolicyDescriptionUpdateCmd
desc
- the short description of the business policypublic void setPolicyId(java.lang.Long policyId)
setPolicyId
in interface PolicyDescriptionUpdateCmd
policyId
- the business policy IDpublic void setPolicyLongDescription(java.lang.String longDesc)
setPolicyLongDescription
in interface PolicyDescriptionUpdateCmd
longDesc
- the long description of business policypublic 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, the required parameter is policyId.com.ibm.commerce.exception.ECApplicationException
- Raised with message _ERR_MISSING_CMD_PARAMETER if one of the these required parameters are missing.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_BUSINESS_POLICY_OBJECT_NOT_FOUND if the provided policy ID cannot be found.AbstractECTargetableCommand.validateParameters()