wt.ixb.publicforapps
Interface ApplicationExportHandler

All Superinterfaces:

ApplicationExpImportHandler

All Known Implementing Classes:

ApplicationExportHandlerTemplate

public interface ApplicationExportHandler

extends ApplicationExpImportHandler

This is the base class for export application handlers.
Any export application must supply for export service such a handler to store exported information. IXB service by itself knows nothing about how to store generated XML files. It completely relies here on the handler, supplied by export application.

There are two different types of the information, that should be stored in the export process:

• XML elements, which are the XML representation of exported objects (of objects' meta data)
• objects' contents - for objects, that are content holders (ContentHolder), e.g. WTDocument

Supported API: true

Extendable: true

Field Summary

Fields inherited from interface wt.ixb.publicforapps.ApplicationExpImportHandler

IMPORTANCE_LEVEL_DEFAULT

Method Summary

void	finalizeAdditionalInfo() Supported API: true
void	reallyStoreContent(Object contentHolder, Exporter exporter, InputStream content, String contentId) Stores the given content of the content parameter "contentAttr".
void	storeAdditionalInfo(Object object, IxbDocument fileXML, String fileId) Stores additional information related to object and its XML representation.
String	storeContent(File file) Stores content files residing in the local file system (as in the case of Representation objects).
String	storeContent(Object contentAttr) Stores the given content of exported object.
String	storeDocument(IxbElement elem) Stores the given XML element, which is the XML representation of exported object, based on Windchill's default DTD for export.
String	storeDocument(IxbElement elem, String dtd) Stores the given XML element, which is the XML representation of exported object, based on the provided DTD.

Methods inherited from interface wt.ixb.publicforapps.ApplicationExpImportHandler

storeLogMessage

Method Detail

storeDocument

public String storeDocument(IxbElement elem)
                     throws WTException

Stores the given XML element, which is the XML representation of exported object, based on Windchill's default DTD for export. Return XML file name or some other string identifier for the stored element.

Supported API: true

Parameters:

elem -

Returns:

String

Throws:

WTException

See Also:

storeDocument (IxbElement elem, String dtd)

storeDocument

public String storeDocument(IxbElement elem,
                            String dtd)
                     throws WTException

Stores the given XML element, which is the XML representation of exported object, based on the provided DTD. If parameter dtd is null, Windchill's default DTD is assumed. Return XML file name or some other string identifier for the stored element.

Supported API: true

Parameters:

elem -

dtd -

Returns:

String

Throws:

WTException

See Also:

storeDocument (IxbElement elem)

storeContent

public String storeContent(Object contentAttr)
                    throws WTException

Stores the given content of exported object. The return value is String, that will be used in XML file as an identifier of this content. Application should be able to find the content during the import process by this identifier. The content of the associated object might not be saved, depending on the implementation of the this interface.

Supported API: true

Parameters:

contentAttr - The content attribute which is related to InputStream or BLOB. e.g. it can be ApplicationData , File or String (full path of a file), etc

Returns:

String

Throws:

WTException

storeContent

public String storeContent(File file)
                    throws WTException

Stores content files residing in the local file system (as in the case of Representation objects).

Supported API: true

Parameters:

file -

Returns:

String

Throws:

WTException

reallyStoreContent

public void reallyStoreContent(Object contentHolder,
                               Exporter exporter,
                               InputStream content,
                               String contentId)
                        throws WTException

Stores the given content of the content parameter "contentAttr". The parameter "contentId" is the unique content ID which was previously computed and returned by storeContent (Object contentAttr).

Supported API: true

Parameters:

contentHolder - The object holding the attribute (directly or indirectly) "contentAttr".

exporter -

content - The content as InputStream which is associated with the contentId.

contentId - The unique content ID which was previously computed by calling "storeContent (Object contentAttr)"

Throws:

WTException

storeAdditionalInfo

public void storeAdditionalInfo(Object object,
                                IxbDocument fileXML,
                                String fileId)
                         throws WTException

Stores additional information related to object and its XML representation.

Supported API: true

Parameters:

object -

fileXML -

fileId -

Throws:

WTException

finalizeAdditionalInfo

public void finalizeAdditionalInfo()
                            throws WTException

Supported API: true

Throws:

WTException