com.ibm.commerce.contract.commands

Class ContractSubmitPreApprovalCmdImpl

  • java.lang.Object
    • com.ibm.websphere.command.CacheableCommandImpl
      • com.ibm.commerce.command.MeasuredCacheableCommandImpl
  • All Implemented Interfaces:
    com.ibm.commerce.command.AccCommand, com.ibm.commerce.command.ControllerCommand, com.ibm.commerce.command.ECCommand, com.ibm.commerce.command.ECTargetableCommand, ContractSubmitPostApprovalCmd, com.ibm.commerce.security.Protectable, BusinessFlowCmd, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command

    public class ContractSubmitPreApprovalCmdImpl
extends BusinessFlowCmdImpl
implements ContractSubmitPostApprovalCmd
    This is the default implementation of the ContractSubmitPreApprovalCmd controller command.

    Input parameters:

    Name Description
    ContractId The ID of the contract. Mandatory.
    StateIdentifier The state identifier. Optional.
    RequestProperties The request properties.Possible values include: redirecturl, storeId. Mandatory.

    Output parameters:

    Name Description
    ContractId The ID of the contract.
    EntityId The entity ID.It is the same as the contract ID.
    EntityObject The business flow entity bean. It is the ContractFlowEntityBean.

    Behaviour:

      This command will be called when a contract is submitted to approve (WebSphere Commerce Enterprise only). It will validate the specified contract. If the contract is invalid contract, an exception will be thrown. If it completes successfully, the contract will be set to Pending state.

    AccessBean called:

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.Long getContractId()
      Returns the ID of the contract.
      java.lang.Long getEntityId()
      Returns the entity ID.
      BusinessFlowEntityBean getEntityObject()
      Returns business flow entity bean.
      void performExecute()
      Executes the business logic of this command implementation.
      void setContractId(java.lang.Long contractId)
      Sets the ID of the contract.
      void setRequestProperties(com.ibm.commerce.datatype.TypedProperty aRequestProperties)
      Retrieves input parameters from the request properties.
      void setStateIdentifier(java.lang.Integer stateIndentifier)
      Sets the state identifier.
      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, getResources, getStoreId, getUser, getUserId, 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, getResources, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

      • Methods inherited from interface com.ibm.commerce.security.Protectable

        fulfills, getOwner

    • Field Detail

      • CLASSNAME

        public static final java.lang.String CLASSNAME
        The name of this command.
        See Also:
        Constant Field Values

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values

    • Constructor Detail

      • ContractSubmitPreApprovalCmdImpl

        public ContractSubmitPreApprovalCmdImpl()

    • Method Detail

      • getContractId

        public java.lang.Long getContractId()
        Returns the ID of the contract.
        Returns:
        the contract ID

      • performExecute

        public void performExecute()
                    throws com.ibm.commerce.exception.ECException
        Executes the business logic of this command implementation.
        Specified by:
        performExecute in interface com.ibm.commerce.command.ECCommand
        Overrides:
        performExecute in class com.ibm.commerce.command.AbstractECTargetableCommand
        Throws:
        com.ibm.commerce.exception.ECException - Raised with message _ERR_CONTRACT_CMD_EXEC if an error occurred when the command trys to change the state of the contract.
        See Also:
        ECCommand.performExecute(), AbstractECTargetableCommand.performExecute()

      • setContractId

        public void setContractId(java.lang.Long contractId)
        Sets the ID of the contract.
        Specified by:
        setContractId in interface ContractSubmitPostApprovalCmd
        Parameters:
        contractId - the contract ID

      • 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 interface com.ibm.commerce.command.ControllerCommand
        Overrides:
        setRequestProperties in class com.ibm.commerce.command.ControllerCommandImpl
        Parameters:
        aRequestProperties - An TypedProperty object contains the input parameters. For this default implementation, storeId and contractId are the required parameters.
        Throws:
        com.ibm.commerce.exception.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 contractId, storeId cannot be converted to Long, Integer object.
        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 interface com.ibm.commerce.command.ECCommand
        Overrides:
        validateParameters in class com.ibm.commerce.command.AbstractECTargetableCommand
        Throws:
        com.ibm.commerce.exception.ECException - Raised with message _ERR_WRONG_CONTRACT_STATE if the contract is not in Draft 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()
Skip navigation links