com.ibm.commerce.contract.commands
Class PolicyDescriptionUpdateCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.ControllerCommandImpl
                    |
                    +--com.ibm.commerce.contract.commands.PolicyDescriptionUpdateCmdImpl
All Implemented Interfaces:
AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, PolicyDescriptionUpdateCmd

public class PolicyDescriptionUpdateCmdImpl
extends ControllerCommandImpl
implements PolicyDescriptionUpdateCmd

Add or update the description of the specified business policy (WebSphere Commerce Business Edition only). The following AccessBeans are used in this default implementation: BusinessPolicyAccessBean, PolicyDescriptionAccessBean

See Also:
Serialized Form

Field Summary
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. PolicyDescriptionUpdateCmd
defaultCommandClassName, NAME
 
Constructor Summary
PolicyDescriptionUpdateCmdImpl()
           
 
Method Summary
  AccessVector getResources()
          Gets the access vector accessed by this command.
 void performExecute()
          Updates the description of the specified business policy.
 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 descrption will be added to.
 void setPolicyLongDescription(java.lang.String longDesc)
          Sets the long description of business policy.
 void setRequestProperties( TypedProperty aRequestProperties)
          Retrieves input parameters from the request properties.
 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
IBM copyright notice field.
See Also:
Constant Field Values
Constructor Detail

PolicyDescriptionUpdateCmdImpl

public PolicyDescriptionUpdateCmdImpl()
Method Detail

getResources

public AccessVector getResources()
                          throws ECException
Gets the access vector accessed by this command. The default implementation returns the BusinessPolicyAccessBean object of the business policy which the description will be added to.
Specified by:
getResources in interface ECCommand
Overrides:
getResources in class AbstractECTargetableCommand
Returns:
AccessVector - a vector of resource action pairs
Throws:
ECException
See Also:
AbstractECTargetableCommand.getResources()

performExecute

public void performExecute()
                    throws ECException
Updates the description of the specified business policy.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECException
See Also:
AbstractECTargetableCommand.performExecute()

setLanguageId

public void setLanguageId(java.lang.Integer langId)
Sets ID of language of the description.
Specified by:
setLanguageId in interface PolicyDescriptionUpdateCmd
Parameters:
langId - the language ID of the description

setPolicyDescription

public void setPolicyDescription(java.lang.String desc)
Sets the short description of the business policy.
Specified by:
setPolicyDescription in interface PolicyDescriptionUpdateCmd
Parameters:
desc - the short description of the business policy

setPolicyId

public void setPolicyId(java.lang.Long policyId)
Sets ID of business policy which the descrption will be added to.
Specified by:
setPolicyId in interface PolicyDescriptionUpdateCmd
Parameters:
policyId - the business policy ID

setPolicyLongDescription

public void setPolicyLongDescription(java.lang.String longDesc)
Sets the long description of business policy.
Specified by:
setPolicyLongDescription in interface PolicyDescriptionUpdateCmd
Parameters:
longDesc - the long description of business policy

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECApplicationException
Retrieves input parameters from the request properties.
Specified by:
setRequestProperties in interface ControllerCommand
Overrides:
setRequestProperties in class ControllerCommandImpl
Parameters:
aRequestProperties - An TypedProperty object contains the input parameters. For this default implementation, the required parameter is policyId.
Throws:
ECApplicationException - Raised with message _ERR_MISSING_CMD_PARAMETER if one of the these required parameters are missing.
See Also:
ControllerCommandImpl.setRequestProperties(TypedProperty)

validateParameters

public void validateParameters()
                        throws ECException
Checks the input parameters.
Specified by:
validateParameters in interface ECCommand
Overrides:
validateParameters in class AbstractECTargetableCommand
Throws:
ECException - Raised with message _ERR_BUSINESS_POLICY_OBJECT_NOT_FOUND if the provided policy ID cannot be found.
See Also:
AbstractECTargetableCommand.validateParameters()