com.ibm.commerce.contract.commands

Interface ImportDTDContractApprovedVersionCmd

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

    public interface ImportDTDContractApprovedVersionCmd
extends com.ibm.commerce.command.TaskCommand
    This contract task command is used to import an approved contract from a specified XML file (WebSphere Commerce Enterprise only). The state of the contract in the XML file has to be either Approved or Active. The default implementation of this command is ImportDTDContractApprovedVersionCmdImpl. The ImportDTDContractApprovedVersion 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 setContractXML(java.io.InputStream iInputStreamContractXML)
      Sets the contract XML instance.
      void setContractXMLFileName(java.lang.String istrContractFileName)
      Sets the contract XML file name.
      void setIbXSDValidation(boolean ibXSDValidation)
      Set the value of xsd validation, default is true.
      void setStoreId(java.lang.Integer storeId)
      Sets The store ID to which the contract will be deployed.
      void setSynchronousDeployment(boolean synchronousDeploymentFlag)
      Sets the synchronousDeployment flag to indicate contract should be deployed synchronously.
      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.

      • setContractXML

        void setContractXML(java.io.InputStream iInputStreamContractXML)
        Sets the contract XML instance.
        Parameters:
        contractXML - an InputStream object contains the contract XML instance

      • setContractXMLFileName

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

      • setIbXSDValidation

        void setIbXSDValidation(boolean ibXSDValidation)
        Set the value of xsd validation, default is true.
        Parameters:
        ibXSDValidation -

      • setStoreId

        void setStoreId(java.lang.Integer storeId)
        Sets The store ID to which the contract will be deployed.
        Parameters:
        storeId - The ID of the store.

      • setSynchronousDeployment

        void setSynchronousDeployment(boolean synchronousDeploymentFlag)
        Sets the synchronousDeployment flag to indicate contract should be deployed synchronously.
        Parameters:
        synchronousDeploymentFlag - true for synchronous deployment, false for asynchronous deployment

      • 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