com.ibm.commerce.contract.commands

Interface ContractExportCmd

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

    public interface ContractExportCmd
extends com.ibm.commerce.command.ControllerCommand
    This controller command is used to export the specified contract. with using the specified language ID to an XML file based on the specified encoding (WebSphere Commerce Enterprise only). The default implementation of this command is ContractExportCmdImpl. The ContractExport 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 setContractId(java.lang.Long contractId)
      Sets the ID of the contract to be exported.
      void setExportAllData(boolean wantsAll)
      Sets the exporting all data flag.
      void setFileName(java.lang.String astrFileName)
      Sets the XML file to which the contract will be exported.
      void setLangId(java.lang.Integer langId)
      Sets the language ID.
      void setUrl(java.lang.String astrUrl)
      Sets the redirection URL to be called when the command completes successfully.
      void setXMLFileEncoding(java.lang.String encoding)
      Sets the encoding.
      void setXSDFileName(java.lang.String xsdName)
      Sets the XSD file name.

      • 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

      • setContractId

        void setContractId(java.lang.Long contractId)
        Sets the ID of the contract to be exported.
        Parameters:
        contractId - ID of the contract

      • setExportAllData

        void setExportAllData(boolean wantsAll)
        Sets the exporting all data flag.
        Parameters:
        wantsAll - the flag to indicate if all the data will be exported. true: exports all the data, false: otherwise

      • setFileName

        void setFileName(java.lang.String astrFileName)
        Sets the XML file to which the contract will be exported.
        Parameters:
        astrFileName - the name of the XML file

      • setLangId

        void setLangId(java.lang.Integer langId)
        Sets the language ID.
        Parameters:
        langId - the language ID of the descriptions in the contract.

      • 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

      • setXMLFileEncoding

        void setXMLFileEncoding(java.lang.String encoding)
        Sets the encoding.
        Parameters:
        encoding - the encoding string

      • setXSDFileName

        void setXSDFileName(java.lang.String xsdName)
        Sets the XSD file name.
        Parameters:
        xsdName - the name of the XSD file.
Skip navigation links