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

Field Summary

private String	actionName
private static String	CLASSNAME
private WTContainerRef	container
private boolean	detailedLog
private String	dtd
static long	EXTERNALIZATION_VERSION_UID
private String	guiId
private Locale	locale
protected static long	OLD_FORMAT_VERSION_UID
private IXBStreamer	policyFile
private boolean	previewOnly
private static String	RESOURCE
private IXBStreamer	ruleFile
(package private) static long	serialVersionUID
private boolean	validation

Constructor Summary

ExportImportParameters()

Method Summary

private void	actionNameValidate(String a_ActionName)
private void	containerValidate(WTContainerRef a_Container)
private void	dtdValidate(String a_Dtd)
String	getActionName() Gets the value of the attribute: actionName; The action which will be applied for all applicable objects during export or import.
WTContainerRef	getContainer() Gets the value of the attribute: container; This parameter specifies the WTContainerRef where the export or import is launched.
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.
Locale	getLocale() Gets the value of the attribute: locale.
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.
IXBStreamer	getRuleFile() Gets the value of the attribute: ruleFile; The mapping rule and properties file in XML format.
private void	guiIdValidate(String a_GuiId)
boolean	isDetailedLog() Gets the value of the attribute: detailedLog.
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	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(ExportImportParameters thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
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	setContainer(WTContainerRef a_Container) Sets the value of the attribute: container; This parameter specifies the WTContainerRef where the export or import is launched.
void	setDetailedLog(boolean a_DetailedLog) Sets the value of the attribute: detailedLog.
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	setLocale(Locale a_Locale) Sets the value of the attribute: locale.
void	setPolicyFile(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(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.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

container

private WTContainerRef container

previewOnly

private boolean previewOnly

validation

private boolean validation

detailedLog

private boolean detailedLog

ruleFile

private IXBStreamer ruleFile

policyFile

private IXBStreamer policyFile

actionName

private String actionName

guiId

private String guiId

dtd

private String dtd

locale

private Locale locale

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

ExportImportParameters

public ExportImportParameters()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(ExportImportParameters thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

getContainer

public WTContainerRef getContainer()

Gets the value of the attribute: container;
This parameter specifies the WTContainerRef where the export or import is launched.

Supported API: false

Returns:

WTContainerRef

setContainer

public void setContainer(WTContainerRef a_Container)
                  throws WTPropertyVetoException

Sets the value of the attribute: container;
This parameter specifies the WTContainerRef where the export or import is launched.

Supported API: false

Parameters:

a_Container -

Throws:

WTPropertyVetoException

containerValidate

private void containerValidate(WTContainerRef a_Container)
                        throws WTPropertyVetoException

Parameters:

a_Container -

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:

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

isDetailedLog

public boolean isDetailedLog()

Gets the value of the attribute: detailedLog.

Supported API: false

Returns:

boolean

setDetailedLog

public void setDetailedLog(boolean a_DetailedLog)
                    throws WTPropertyVetoException

Sets the value of the attribute: detailedLog.

Supported API: false

Parameters:

a_DetailedLog -

Throws:

WTPropertyVetoException

getRuleFile

public 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(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 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(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

actionNameValidate

private void actionNameValidate(String a_ActionName)
                         throws WTPropertyVetoException

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

guiIdValidate

private void guiIdValidate(String a_GuiId)
                    throws WTPropertyVetoException

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

dtdValidate

private void dtdValidate(String a_Dtd)
                  throws WTPropertyVetoException

Parameters:

a_Dtd -

Throws:

WTPropertyVetoException

getLocale

public Locale getLocale()

Gets the value of the attribute: locale.

Supported API: false

Returns:

Locale

setLocale

public void setLocale(Locale a_Locale)
               throws WTPropertyVetoException

Sets the value of the attribute: locale.

Supported API: false

Parameters:

a_Locale -

Throws:

WTPropertyVetoException