wt.ixb.handlers.netmarkets
Class OrgConfigIXHandler

java.lang.Object
  wt.ixb.publicforhandlers.ClassExporterImporterTemplateGeneral
      wt.ixb.publicforhandlers.ClassExporterImporterTemplate
          wt.ixb.handlers.netmarkets.OrgConfigIXHandler

All Implemented Interfaces:

ClassExporter, ClassExporterImporter, ElementImporter

public class OrgConfigIXHandler

extends ClassExporterImporterTemplate

This class is the handler for the tag. This element is always processed in the context of a Project container. An exception is thrown if this element is processed outside of a project container.

Nested Class Summary

Nested classes inherited from class wt.ixb.publicforhandlers.ClassExporterImporterTemplate

ClassExporterImporterTemplate.ContentHolderCommitListener

Field Summary

private static String	_rb
private static NMProjectConstants.DocTemplateInfo	docTemplTags
private static NMProjectConstants.EngineRuleInfo	engineTags
private static NMProjectConstants.LibraryTemplateInfo	libTempl
private static NMProjectConstants.OrgConfigInfo	orgTags
private static NMProjectConstants.ProjectEnumTypeInfo	petTags
private static NMProjectConstants.ProductTemplateInfo	prdTempl
private static NMProjectConstants.SeedObjectRuleInfo	seedTags
private static NMProjectConstants.TypeBasedRuleInfo	typeRuleTags

Fields inherited from class wt.ixb.publicforhandlers.ClassExporterImporterTemplate

Fields inherited from class wt.ixb.publicforhandlers.ClassExporterImporterTemplateGeneral

CONFLICT_RESOURCE

Constructor Summary

OrgConfigIXHandler()

Method Summary

Object	createObject(IxbElement elem, Importer imp) This controls the import of all the objects.
void	exportObject(Object obj, Exporter exp) Exports the specified object in context given by parameter exporter.
Object	findAmongExistingObjects(IxbElement obj, Importer imp) Implements typical way of finding whether object from given XML file exists already in Windchill database.
int	getImportPriority() Return the import priority of the object type represented by this import handler.
Object	storeObject(Object obj, IxbElement elem, Importer imp) That is the general template how to store object.

Methods inherited from class wt.ixb.publicforhandlers.ClassExporterImporterTemplate

createFileXMLOnExport, exportAttributes, finalizeImportObject, getRootTag, importElement, importObjectAttributes, importObjectAttributesAfterStore, isObjectIgnored, isObjectNew, outputLog, rememberNewObInfo, setObjectIgnored, setObjectIsNew, storeAdditionalInfo, storeElement

Methods inherited from class wt.ixb.publicforhandlers.ClassExporterImporterTemplateGeneral

checkConflicts, finalizeCheckConflicts, finalizeExport, finalizeImport, getAdditionalImportPriority, getObjectDisplayID, prepareForCheckConflicts, prepareForImport, previewElement

Methods inherited from class java.lang.Object

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

Field Detail

orgTags

private static final NMProjectConstants.OrgConfigInfo orgTags

engineTags

private static final NMProjectConstants.EngineRuleInfo engineTags

typeRuleTags

private static final NMProjectConstants.TypeBasedRuleInfo typeRuleTags

seedTags

private static final NMProjectConstants.SeedObjectRuleInfo seedTags

libTempl

private static final NMProjectConstants.LibraryTemplateInfo libTempl

prdTempl

private static final NMProjectConstants.ProductTemplateInfo prdTempl

docTemplTags

private static final NMProjectConstants.DocTemplateInfo docTemplTags

petTags

private static final NMProjectConstants.ProjectEnumTypeInfo petTags

_rb

private static final String _rb

See Also:

Constant Field Values

Constructor Detail

OrgConfigIXHandler

public OrgConfigIXHandler()

Method Detail

exportObject

public void exportObject(Object obj,
                         Exporter exp)
                  throws WTException

Description copied from class: ClassExporterImporterTemplate

Exports the specified object in context given by parameter exporter.
The implementation of this method is partitioned into several protected methods. Individual class handlers can override the following protected methods:

• createFileXMLOnExport(Exporter exporter), which create an IxbDocument with the root tag. See getRootTag();
• exportAttributes (Object object, IxbElement fileXML, Exporter exporter) which will export the attributes according to the DTD. The parameter fileXML is the returned vlue from createFileXMLOnExport(Exporter exporter).
• storeElement(Object object, IxbElement fileXML, Exporter exporter) which will store the fileXML into an xml-file.

Also, export actions from either client or system registry will be performed. Specifically, the two methods wt.ixb.tuner.ExportActionHelper.performPreExportAction () and wt.ixb.tuner.ExportActionHelper.performPostExportAction () will be called before and after th above three protected methods, respectively.

Supported API: true

Specified by:

exportObject in interface ClassExporter

Overrides:

exportObject in class ClassExporterImporterTemplate

Parameters:

obj -

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

Throws:

WTException

createObject

public Object createObject(IxbElement elem,
                           Importer imp)
                    throws WTException

This controls the import of all the objects. On exception all transactions are rolled back.

Specified by:

createObject in class ClassExporterImporterTemplate

Parameters:

elem -

imp -

Returns:

Object

Throws:

WTException

getImportPriority

public int getImportPriority()
                      throws WTException

Description copied from class: ClassExporterImporterTemplateGeneral

Return the import priority of the object type represented by this import handler.
Import priority defines the order in which objects will be imported. This method does not carry parameters in the signature. The return value can not be negative. Those XML files will have a higher import priority for smaller returned values.

Supported API: true

Specified by:

getImportPriority in interface ElementImporter

Specified by:

getImportPriority in class ClassExporterImporterTemplateGeneral

Returns:

int

Throws:

WTException

findAmongExistingObjects

public Object findAmongExistingObjects(IxbElement obj,
                                       Importer imp)
                                throws WTException

Description copied from class: ClassExporterImporterTemplate

Implements typical way of finding whether object from given XML file exists already in Windchill database.

Supported API: true

Overrides:

findAmongExistingObjects in class ClassExporterImporterTemplate

Parameters:

obj -

imp -

Returns:

Object

Throws:

WTException

storeObject

public Object storeObject(Object obj,
                          IxbElement elem,
                          Importer imp)
                   throws WTException

Description copied from class: ClassExporterImporterTemplate

That is the general template how to store object. It looks like it will be good for many classes. If for some class it is not good then it can be override this method

Supported API: true

Overrides:

storeObject in class ClassExporterImporterTemplate

Parameters:

obj -

elem -

imp -

Returns:

Object

Throws:

WTException