com.ibm.commerce.contract.commands

Interface ContractCopyCmd

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


    public interface ContractCopyCmd
    extends com.ibm.commerce.command.ControllerCommand
    This controller command is used to copy a contract (WebSphere Commerce Enterprise only). If the command completes successfully, a new contract will be create. The contract will be in Draft state with majorVersion set to 1 and minorVersion set to 0. The default implementation of this command is ContractCopyCmdImpl. The ContractCopy 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
      void setAccountId(java.lang.Long accountId)
      Sets the ID of the account to which to copy the contract.
      void setContractId(java.lang.Long contractId)
      Sets the ID of the contract to be copied from.
      void setNewContractName(java.lang.String name)
      Sets the name of the new contract.
      • 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

      • setAccountId

        void setAccountId(java.lang.Long accountId)
        Sets the ID of the account to which to copy the contract.
        Parameters:
        accountId - the ID of the account
      • setContractId

        void setContractId(java.lang.Long contractId)
        Sets the ID of the contract to be copied from.
        Parameters:
        contractId - the ID of the contract to be copied from
      • setNewContractName

        void setNewContractName(java.lang.String name)
        Sets the name of the new contract.
        Parameters:
        name - the name of the new contract