com.ibm.commerce.contract.commands

Interface ContractSuspendCmd

  • 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:
    ContractSuspendCmdImpl

    public interface ContractSuspendCmd
extends com.ibm.commerce.command.ControllerCommand
    This contract controller command is used to suspend an active contract and refresh the contract cache (WebSphere Commerce Enterprise only). The default implementation of this command is ContractSuspendCmdImpl. The ContractSuspendURL URL is mapped to this command by default.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
      static java.lang.String defaultCommandClassName
      The name of the default implementation class.
      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 suspended contract.
      void setContractId(java.lang.Long contractId)
      Sets id of the contract to be suspended.

      • 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
        IBM copyright notice field.
        See Also:
        Constant Field Values

      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The name of the default implementation class.
        See Also:
        Constant Field Values

    • Method Detail

      • getContractId

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

      • setContractId

        void setContractId(java.lang.Long contractId)
        Sets id of the contract to be suspended.
        Parameters:
        contractId - the id of the contract to be suspended
Skip navigation links