com.ibm.commerce.contract.commands

Interface ContractDeleteCmd

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

    public interface ContractDeleteCmd
extends com.ibm.commerce.command.ControllerCommand
    This controller command is used to delete the specified contracts by setting the contracts to MarkForDelete (WebSphere Commerce Enterprise only). This command does not remove the contract from the database immediately. A contract has to be in one of the following state to run this command: Draft, Cancelled, Closed. The default implementation of this command is ContractDeleteCmdImpl. The ContractDelete 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.String[] getContractIdList()
      Return the ID list of the contract(s) to be deleted.
      void setContractIdList(java.lang.String[] anContractIdList)
      Sets the id list of the contract(s) to 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

      • getContractIdList

        java.lang.String[] getContractIdList()
        Return the ID list of the contract(s) to be deleted.
        Returns:
        a String array of the list of contract IDs

      • setContractIdList

        void setContractIdList(java.lang.String[] anContractIdList)
        Sets the id list of the contract(s) to be deleted.
        Parameters:
        anContractIdList - a String object of the list of contract ids
Skip navigation links