com.ibm.commerce.contract.commands

Interface ContractCancelCmd

  • All Superinterfaces:
    com.ibm.commerce.command.AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.commerce.command.ControllerCommand, com.ibm.commerce.command.ECCommand, com.ibm.commerce.security.Protectable
    All Known Implementing Classes:
    ContractCancelCmdImpl

    public interface ContractCancelCmd
extends com.ibm.commerce.command.ControllerCommand
    This controller command is used to cancel the specified contract by changing its contract state to Cancelled (WebSphere Commerce Enterprise only). This command does not remove the contract from the database. A contract can be cancelled any time except the contract is in Draft, DeploymentInProgress, or Closed state. The default implementation of this command is ContractCancelCmdImpl. The ContractCancel URL is mapped to this command by default.

    • 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 of this command.
      static java.lang.String NAME
      The name of this interface.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      java.lang.Long getContractId()
      Returns the ID of the canceled contract.
      void setContractId(java.lang.Long contractId)
      Sets the ID of the contract to be cancelled.
      void setDeleteContract(boolean deleteFlag)
      Sets whether the contract should be deleted.

      • Methods inherited from class java.lang.Object

        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, setRequestProperties, 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, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

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

        fulfills, getOwner

    • 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 of this command.
        See Also:
        Constant Field Values

    • Method Detail

      • getContractId

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

      • setContractId

        void setContractId(java.lang.Long contractId)
        Sets the ID of the contract to be cancelled.
        Parameters:
        contractId - the id of the contract

      • setDeleteContract

        void setDeleteContract(boolean deleteFlag)
        Sets whether the contract should be deleted.
        Parameters:
        deleteFlag - true if the contract should be deleted, false otherwise
Skip navigation links