com.ibm.commerce.contract.commands

Interface ImportDTDContractDraftVersionCmd

  • All Superinterfaces:
    com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.commerce.command.ECCommand, com.ibm.commerce.command.TaskCommand
    All Known Implementing Classes:
    ImportDTDContractDraftVersionCmdImpl

    public interface ImportDTDContractDraftVersionCmd
extends com.ibm.commerce.command.TaskCommand
    This contract task command is used to import a draft contract from a specified XML file (WebSphere Commerce Enterprise only). The state of the contract in the XML file should be Draft. The default implementation of this command is com.ibm.commerce.contract.commands.ImportDTDContractDraftVersionCmdImpl>. The ImportDTDContractDraftVersion 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 default implementation class name of this interface.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      com.ibm.commerce.datatype.TypedProperty getResponseProperties()
      Returns the responseProperties of the command.
      void setContractXMLFileName(java.lang.String istrContractFileName)
      Sets the contract XML file name.
      void setUrl(java.lang.String astrUrl)
      Sets the redirection URL to be called when the command completes successfully.
      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.CacheableECCommand

        execute

      • Methods inherited from interface com.ibm.commerce.command.ECCommand

        checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

    • 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 default implementation class name of this interface.
        See Also:
        Constant Field Values

    • Method Detail

      • getResponseProperties

        com.ibm.commerce.datatype.TypedProperty getResponseProperties()
        Returns the responseProperties of the command.
        Returns:
        responseProperties The response properties which contains the contract ids.

      • setContractXMLFileName

        void setContractXMLFileName(java.lang.String istrContractFileName)
        Sets the contract XML file name.
        Parameters:
        istrContractFileName - The name of the contract XML file.

      • setUrl

        void setUrl(java.lang.String astrUrl)
        Sets the redirection URL to be called when the command completes successfully.
        Parameters:
        astrUrl - The redirection URL string.

      • setXMLEntityPath

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