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:

Serialized Form

Method Summary

String	getActionName() Gets the value of the attribute: actionName; The action which will be applied for all applicable objects during export or import.
String	getDtd() Gets the value of the attribute: dtd; The DTD 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.
wt.ixb.clientAccess.IXBStreamer	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.
wt.ixb.clientAccess.IXBStreamer	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 a_ActionName) Sets the value of the attribute: actionName; The action which will be applied for all applicable objects during export or import.
void	setDtd(String a_Dtd) Sets the value of the attribute: dtd; The DTD for export or import.
void	setGuiId(String a_GuiId) Sets the value of the attribute: guiId; The unique identifier to identify the export or import request from each client.
void	setPolicyFile(wt.ixb.clientAccess.IXBStreamer a_PolicyFile) 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 a_PreviewOnly) 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(wt.ixb.clientAccess.IXBStreamer a_RuleFile) Sets the value of the attribute: ruleFile; The mapping rule and properties file in XML format.
void	setValidation(boolean a_Validation) 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 Detail

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:

boolean

setPreviewOnly

public void setPreviewOnly(boolean a_PreviewOnly)
                    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:

a_PreviewOnly -

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:

boolean

setValidation

public void setValidation(boolean a_Validation)
                   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:

a_Validation -

Throws:

WTPropertyVetoException

getRuleFile

public wt.ixb.clientAccess.IXBStreamer 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>. The values will override the values set in the server context.

Supported API: true

Returns:

IXBStreamer

setRuleFile

public void setRuleFile(wt.ixb.clientAccess.IXBStreamer a_RuleFile)
                 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>. The values will override the values set in the server context.

Supported API: true

Parameters:

a_RuleFile -

Throws:

WTPropertyVetoException

getPolicyFile

public wt.ixb.clientAccess.IXBStreamer 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:

IXBStreamer

setPolicyFile

public void setPolicyFile(wt.ixb.clientAccess.IXBStreamer a_PolicyFile)
                   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:

a_PolicyFile -

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:

String

setActionName

public void setActionName(String a_ActionName)
                   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:

a_ActionName -

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:

String

setGuiId

public void setGuiId(String a_GuiId)
              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:

a_GuiId -

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:

String

setDtd

public void setDtd(String a_Dtd)
            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:

a_Dtd -

Throws:

WTPropertyVetoException