com.ibm.commerce.contract.commands

Interface CloseContractCmd

  • All Superinterfaces:
    com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.commerce.command.ECCommand, com.ibm.commerce.command.TaskCommand
    All Known Implementing Classes:
    CloseContractCmdImpl


    public interface CloseContractCmd
    extends com.ibm.commerce.command.TaskCommand
    This task command is used to close all the contracts which in active, approved, or suspended state within the same family as the deploying contract. If an error occurred, an ECException will be thrown. The default implementation of this command is CloseContractCmdImpl.
    See Also:
    DeployContractCmd
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      The IBM copyright notice field.
      static java.lang.String defaultCommandClassName
      The default implementation class name of this interface.
      static java.lang.String NAME
      The full name of this interface.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      void setContractId(java.lang.Long contractId)
      Sets the ID of the deploying contract.
      void setStoreId(java.lang.Integer storeId)
      Sets the ID of the store to which the contract is deployed.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

        execute
      • Methods inherited from interface com.ibm.commerce.command.ECCommand

        checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
    • Field Detail

      • COPYRIGHT

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

        static final java.lang.String defaultCommandClassName
        The default implementation class name of this interface.
        See Also:
        Constant Field Values
      • NAME

        static final java.lang.String NAME
        The full name of this interface.
        See Also:
        Constant Field Values
    • Method Detail

      • setContractId

        void setContractId(java.lang.Long contractId)
        Sets the ID of the deploying contract.
        Parameters:
        contractId - the ID of the deploying contract
      • setStoreId

        void setStoreId(java.lang.Integer storeId)
        Sets the ID of the store to which the contract is deployed.
        Parameters:
        storeId - the ID of the store