Package wt.ixb.clientAccess

Class ExportImportParameters

java.lang.Object
wt.ixb.clientAccess.ExportImportParameters
All Implemented Interfaces:
Externalizable, Serializable
Direct Known Subclasses:
ObjectExportParameters, ObjectImportParameters
public class ExportImportParameters extends Object implements Externalizable
The mapping rule file in XML format.

Supported API: true

Extendable: false
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getActionName()
    Gets the value of the attribute: actionName; The action which will be applied for all applicable objects during export or import.
    ExpImpContextData
    getContextData()
    Gets the value of the context data.
    String
    getDtd()
    Gets the value of the attribute: dtd; The DTD for export or import.
    ExportImportFormatType
    getFormatType()
    Gets the value of the attribute: formatType; The formatType for export or import.
    String
    getGuiId()
    Gets the value of the attribute: guiId; The unique identifier to identify the export or import request from each client.
    IXBCommonStreamer
    getPolicyFile()
    Gets the value of the attribute: policyFile;
    This attribute specifies the policy (such as import action, mapping, etc) for export/import in XSL file format.
    IXBCommonStreamer
    getRuleFile()
    Gets the value of the attribute: ruleFile; The mapping rule and properties file in XML format.
    boolean
    isPreviewOnly()
    Gets the value of the attribute: previewOnly;
    If this parameter is set to true, the actual export or import will not be performed.
    boolean
    isValidation()
    Gets the value of the attribute: validation;
    This parameter specifies whether the XML files should be validated against the DTD or not.
    void
    setActionName(String aActionName)
    Sets the value of the attribute: actionName; The action which will be applied for all applicable objects during export or import.
    void
    setContainer(WTContainerRef aContainer)
    Sets the value of the attribute: container;
    This parameter specifies the WTContainerRef where the export or import is launched.
    void
    setDetailedLog(boolean aDetailedLog)
    Sets the value of the attribute: detailedLog.
    void
    setDtd(String aDtd)
    Sets the value of the attribute: dtd; The DTD for export or import.
    void
    setFormatType(ExportImportFormatType formatType)
    Sets the value of the attribute: formatType.
    void
    setGuiId(String aGuiId)
    Sets the value of the attribute: guiId; The unique identifier to identify the export or import request from each client.
    void
    setIXFormatType(IXFormatType ixFormatType)
    Sets the object of IXFormatType in contextData.
    void
    setLocale(Locale aLocale)
    Sets the value of the attribute: locale.
    void
    setPolicyFile(IXBCommonStreamer aPolicyFile)
    Sets the value of the attribute: policyFile;
    This attribute specifies the policy (such as import action, mapping, etc) for export/import in XSL file format.
    void
    setPreviewOnly(boolean aPreviewOnly)
    Sets the value of the attribute: previewOnly;
    If this parameter is set to true, the actual export or import will not be performed.
    void
    setRuleFile(IXBCommonStreamer aRuleFile)
    Sets the value of the attribute: ruleFile; The mapping rule and properties file in XML format.
    void
    setValidation(boolean aValidation)
    Sets the value of the attribute: validation;
    This parameter specifies whether the XML files should be validated against the DTD or not.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • setContainer

      public void setContainer(WTContainerRef aContainer) throws WTPropertyVetoException
      Sets the value of the attribute: container;
      This parameter specifies the WTContainerRef where the export or import is launched.

      Supported API: true
      Parameters:
      aContainer -
      Throws:
      WTPropertyVetoException

    • isPreviewOnly

      public boolean isPreviewOnly()
      Gets the value of the attribute: previewOnly;
      If this parameter is set to true, the actual export or import will not be performed.

      Supported API: true
      Returns:

    • setPreviewOnly

      public void setPreviewOnly(boolean aPreviewOnly) throws WTPropertyVetoException
      Sets the value of the attribute: previewOnly;
      If this parameter is set to true, the actual export or import will not be performed.

      Supported API: true
      Parameters:
      aPreviewOnly -
      Throws:
      WTPropertyVetoException

    • isValidation

      public boolean isValidation()
      Gets the value of the attribute: validation;
      This parameter specifies whether the XML files should be validated against the DTD or not. This value is generally set to false for export and true for import.

      Supported API: true
      Returns:

    • setValidation

      public void setValidation(boolean aValidation) throws WTPropertyVetoException
      Sets the value of the attribute: validation;
      This parameter specifies whether the XML files should be validated against the DTD or not. This value is generally set to false for export and true for import.

      Supported API: true
      Parameters:
      aValidation -
      Throws:
      WTPropertyVetoException

    • setDetailedLog

      public void setDetailedLog(boolean aDetailedLog) throws WTPropertyVetoException
      Sets the value of the attribute: detailedLog.

      Supported API: true
      Parameters:
      aDetailedLog -
      Throws:
      WTPropertyVetoException

    • getRuleFile

      public IXBCommonStreamer getRuleFile()
      Gets the value of the attribute: ruleFile; The mapping rule and properties file in XML format.
      There are two parts in such an XML file:
      • The mapping rules under the tag <mappingRules>
      • The properties under the tag <properties&gt. The values will override the values set in the server context.


      Supported API: true
      Returns:

    • setRuleFile

      public void setRuleFile(IXBCommonStreamer aRuleFile) throws WTPropertyVetoException
      Sets the value of the attribute: ruleFile; The mapping rule and properties file in XML format.
      There are two parts in such an XML file:
      • The mapping rules under the tag <mappingRules>
      • The properties under the tag <properties&gt. The values will override the values set in the server context.


      Supported API: true
      Parameters:
      aRuleFile -
      Throws:
      WTPropertyVetoException

    • getPolicyFile

      public IXBCommonStreamer getPolicyFile()
      Gets the value of the attribute: policyFile;
      This attribute specifies the policy (such as import action, mapping, etc) for export/import in XSL file format.

      Supported API: true
      Returns:

    • setPolicyFile

      public void setPolicyFile(IXBCommonStreamer aPolicyFile) throws WTPropertyVetoException
      Sets the value of the attribute: policyFile;
      This attribute specifies the policy (such as import action, mapping, etc) for export/import in XSL file format.

      Supported API: true
      Parameters:
      aPolicyFile -
      Throws:
      WTPropertyVetoException

    • getActionName

      public String getActionName()
      Gets the value of the attribute: actionName; The action which will be applied for all applicable objects during export or import.

      Supported API: true
      Returns:

    • setActionName

      public void setActionName(String aActionName) throws WTPropertyVetoException
      Sets the value of the attribute: actionName; The action which will be applied for all applicable objects during export or import.

      Supported API: true
      Parameters:
      aActionName -
      Throws:
      WTPropertyVetoException

    • getGuiId

      public String getGuiId()
      Gets the value of the attribute: guiId; The unique identifier to identify the export or import request from each client. This will be used for server-client communications.

      Supported API: true
      Returns:

    • setGuiId

      public void setGuiId(String aGuiId) throws WTPropertyVetoException
      Sets the value of the attribute: guiId; The unique identifier to identify the export or import request from each client. This will be used for server-client communications.

      Supported API: true
      Parameters:
      aGuiId -
      Throws:
      WTPropertyVetoException

    • getDtd

      public String getDtd()
      Gets the value of the attribute: dtd; The DTD for export or import. If not set, the export/import will use the default DTD provided by IXB framework.

      Supported API: true
      Returns:

    • setDtd

      public void setDtd(String aDtd) throws WTPropertyVetoException
      Sets the value of the attribute: dtd; The DTD for export or import. If not set, the export/import will use the default DTD provided by IXB framework.

      Supported API: true
      Parameters:
      aDtd -
      Throws:
      WTPropertyVetoException

    • setLocale

      public void setLocale(Locale aLocale) throws WTPropertyVetoException
      Sets the value of the attribute: locale.

      Supported API: true
      Parameters:
      aLocale -
      Throws:
      WTPropertyVetoException

    • getFormatType

      public ExportImportFormatType getFormatType()
      Gets the value of the attribute: formatType; The formatType for export or import. If not set, the export/import will use the default formatType provided by IXB framework.

      Supported API: true
      Returns:

    • setFormatType

      public void setFormatType(ExportImportFormatType formatType) throws WTPropertyVetoException
      Sets the value of the attribute: formatType.

      Supported API: true
      Parameters:
      formatType -
      Throws:
      WTPropertyVetoException

    • getContextData

      public ExpImpContextData getContextData()
      Gets the value of the context data.

      Supported API: true
      Returns:
      contextData

    • setIXFormatType

      public void setIXFormatType(IXFormatType ixFormatType) throws WTPropertyVetoException
      Sets the object of IXFormatType in contextData. IXFormatType have multiple attributes i.e. protocol, implementationMethod, formatType, version.

      Supported API: true
      Parameters:
      ixFormatType -
      Throws:
      WTPropertyVetoException