wt.ixb.publicforhandlers
Interface AttributeExporterImporter

All Known Implementing Classes:

AttributeExporterImporterTemplate

public interface AttributeExporterImporter

Interface for all attribute handrlers for export and import.Some attributes are common for some object classes, in this case the implementation of export/import this attribute should implements this interface so that it can be re-useable.

Supported API: true

Extendable: false

Method Summary

void	checkConflictForAttribute(Object existingOb, IxbElement fileXML, Importer importer) Checks conflicts that can arise while import process for the given attribute and object.
void	exportAttribute(Object ob, IxbElement fileXML, Exporter exporter) Exports the attributes of the given object.
void	finalizeCheckConflicts(Importer importer) Called in the end of conflict check process.
void	finalizeExport(Exporter exporter) This method will be called by the application handler after all objects have been exported.
void	finalizeImport(Importer importer) Called in the end of the whole ipport process to execute any import process finalization.
Object	importAttribute(Object ob, IxbElement fileXML, Importer importer) Imports all available attributes from fileXML into the object in context given by importer parameter.
void	prepareForCheckConflicts(Importer importer) Called in the beginning of conflict check process prior to the real import or preview.
void	prepareForImport(Importer importer) Called in the end of conflict check process and prior to the real import process.

Method Detail

exportAttribute

void exportAttribute(Object ob,
                     IxbElement fileXML,
                     Exporter exporter)
                     throws WTException

Exports the attributes of the given object. The results are written into fileXML.

Supported API: true

Parameters:

ob - The object to be exported.

fileXML - The IxbElement instance to hold the export information.

exporter - The Exporter instance that represents the context of the export operation.

Throws:

WTException

finalizeExport

void finalizeExport(Exporter exporter)
                    throws WTException

This method will be called by the application handler after all objects have been exported.

Supported API: true

Parameters:

exporter - The Exporter instance that represents the context of the export operation.

Throws:

WTException

prepareForCheckConflicts

void prepareForCheckConflicts(Importer importer)
                              throws WTException

Called in the beginning of conflict check process prior to the real import or preview.

Supported API: true

Parameters:

importer - The Importer instance that represents the context of the import operation.

Throws:

WTException

checkConflictForAttribute

void checkConflictForAttribute(Object existingOb,
                               IxbElement fileXML,
                               Importer importer)
                               throws WTException

Checks conflicts that can arise while import process for the given attribute and object.

Supported API: true

Parameters:

existingOb -

fileXML - the IxbElement of the XML file to be imported.

importer - The Importer instance that represents the context of the import operation.

Throws:

WTException

finalizeCheckConflicts

void finalizeCheckConflicts(Importer importer)
                            throws WTException

Called in the end of conflict check process.

Supported API: true

Parameters:

importer - The Importer instance that represents the context of the import operation.

Throws:

WTException

prepareForImport

void prepareForImport(Importer importer)
                      throws WTException

Called in the end of conflict check process and prior to the real import process.

Supported API: true

Parameters:

importer - The Importer instance that represents the context of the import operation.

Throws:

WTException

importAttribute

Object importAttribute(Object ob,
                       IxbElement fileXML,
                       Importer importer)
                       throws WTException

Imports all available attributes from fileXML into the object in context given by importer parameter. Returns the imported object.

Supported API: true

Parameters:

ob - The object to be imported.

fileXML - the IxbElement of the XML file to be imported.

importer - The Importer instance that represents the context of the import operation.

Returns:

Object

Throws:

WTException

finalizeImport

void finalizeImport(Importer importer)
                    throws WTException

Called in the end of the whole ipport process to execute any import process finalization.

Supported API: true

Parameters:

importer - The Importer instance that represents the context of the import operation.

Throws:

WTException