com.ibm.commerce.contract.commands

Interface ContractImportApprovedVersionCmd

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

    public interface ContractImportApprovedVersionCmd
extends com.ibm.commerce.command.ControllerCommand
    This controller command is used to import a 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 ContractImportApprovedVersionCmdImpl. The ContractImportApprovedVersion 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 class name of this interface.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      void setContractListFileName(boolean isContractListFlag)
      Sets the contractList flag to indicate the file is a list of contract files to import.
      void setContractXML(java.io.InputStream contractXML)
      Sets the contract XML instance.
      void setContractXMLFileName(java.lang.String contractFileName)
      Sets the contract XML file name.
      void setRootElement(org.w3c.dom.Element rootElement)
      Sets the root Element of the contract XML file.
      void setStoreId(java.lang.Integer storeId)
      Sets the ID of the store 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 redirect URL to be called when the command completes successfully.
      void setXMLEntityPath(java.lang.String path)
      Sets the XML entity path.
      void setXSDFlag(boolean xsdFlag)
      Sets the XSD flag to indicate the XML instance file is based on XSD or DTD.

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

    • Method Detail

      • setContractListFileName

        void setContractListFileName(boolean isContractListFlag)
        Sets the contractList flag to indicate the file is a list of contract files to import.
        Parameters:
        isContractListFlag - true if the file is a list of contract files to import, false otherwise

      • setContractXML

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

      • setContractXMLFileName

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

      • setRootElement

        void setRootElement(org.w3c.dom.Element rootElement)
        Sets the root Element of the contract XML file.
        Parameters:
        rootElement - the document Element object of the contract XML

      • setStoreId

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

      • 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 redirect URL to be called when the command completes successfully.
        Parameters:
        astrUrl - the redirect URL string

      • 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)

      • setXSDFlag

        void setXSDFlag(boolean xsdFlag)
        Sets the XSD flag to indicate the XML instance file is based on XSD or DTD.
        Parameters:
        xsdFlag - XSD flag, true for XSD, false for DTD
Skip navigation links