com.ibm.commerce.contract.commands

Class ContractUnlockCmdImpl

  • 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.ContractUnlockCmdImpl
  • All Implemented Interfaces:
    com.ibm.commerce.command.AccCommand, com.ibm.commerce.command.ControllerCommand, com.ibm.commerce.command.ECCommand, com.ibm.commerce.command.ECTargetableCommand, ContractUnlockCmd, com.ibm.commerce.security.Protectable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command

    public class ContractUnlockCmdImpl
extends com.ibm.commerce.command.ControllerCommandImpl
implements ContractUnlockCmd
    This is the default implementation of the ContractUnlockCmd controller command.

    Input parameters:

    Name Description
    ContractId The ID of the contract. Mandatory.
    RequestProperties The request properties.Possible values include: redirecturl, contractId, accountId. Mandatory.

    Output parameters:

    Name Description
    ContractId The ID of the contract.
    Resources the access vector accessed by this command

    Behaviour:

      Unlocks a contract and clears any locks associated with the contract.

    AccessBeans called:

    • ContractAccessBean

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.Long getContractId()
      Gets the ID of the unlocked 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 newContractId)
      Sets the ID of the contract to be unlocked.
      void setRequestProperties(com.ibm.commerce.datatype.TypedProperty aRequestProperties)
      Retrieves input parameters from the request properties.
      void validateParameters()
      Validates if the given contract ID exists.

      • 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

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

        fulfills, getOwner

    • 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

    • Constructor Detail

      • ContractUnlockCmdImpl

        public ContractUnlockCmdImpl()

    • Method Detail

      • getContractId

        public java.lang.Long getContractId()
        Gets the ID of the unlocked contract.
        Specified by:
        getContractId in interface ContractUnlockCmd
        Returns:
        The ID of the unlocked 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 the contract to be unlocked.

        Specified by:
        getResources in interface com.ibm.commerce.command.ECCommand
        Overrides:
        getResources in class com.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 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 when an error occurs.

      • setContractId

        public void setContractId(java.lang.Long newContractId)
        Sets the ID of the contract to be unlocked.
        Specified by:
        setContractId in interface ContractUnlockCmd
        Parameters:
        newContractId - The ID of the contract to be unlocked.

      • 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 - A 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 the contractId is missed from the URL. Raised with message _ERR_NUMBER_FORMAT_EXCEPTION if the contractId provided from the URL does not match its type.
        See Also:
        ControllerCommandImpl.setRequestProperties(TypedProperty)

      • validateParameters

        public void validateParameters()
                        throws com.ibm.commerce.exception.ECException
        Validates if the given contract ID exists.
        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_CONTRACT_OBJECT_NOT_FOUND if the contract cannot be found. The contract is based on the provided contract ID.
        See Also:
        AbstractECTargetableCommand.validateParameters()
Skip navigation links