com.ibm.commerce.contract.commands

Interface ContractCreateCmd

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

    public interface ContractCreateCmd
extends com.ibm.commerce.command.ControllerCommand
    This controller command is used to create a contract based on the import XMLString. The contract will be in Draft state (WebSphere Commerce Enterprise only). The default implementation of this command is ContractCreateCmdImpl. The ContractCreate 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 newly created contract.
      void setLanguageId(java.lang.Integer langId)
      Sets the language ID.
      void setXML(java.lang.String xmlString)
      Sets the XML string which contains the contract.
      void setXMLEntityPath(java.lang.String path)
      Sets the XML entity path.

      • 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 newly created contract.
        Returns:
        the ID of the newly contract

      • setLanguageId

        void setLanguageId(java.lang.Integer langId)
        Sets the language ID.
        Parameters:
        langId - the ID of the language

      • setXML

        void setXML(java.lang.String xmlString)
        Sets the XML string which contains the contract.
        Parameters:
        xmlString - the XML string in XML format which contains the contract

      • setXMLEntityPath

        void setXMLEntityPath(java.lang.String path)
        Sets the XML entity path.
        Parameters:
        path - the path where it can find the DTD or XML Schema file(s)
Skip navigation links