wt.ixb.handlers.netmarkets
Class OrgStructureIXHandler

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

All Implemented Interfaces:

ClassExporter, ClassExporterImporter, ElementImporter

public class OrgStructureIXHandler

extends ClassExporterImporterTemplate

There is not a one to one correspondence between organization structure and a Windchill object. However organization structures are a convenient unit for administrative reasons. This class allows an administrator to manage domains, groups, folder structures, and permission lists in one convenient xml document. The whole process is a transaction, so partial failure will result in the rollback of the entire set. The xml tag this handler expects is

Nested Class Summary

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

ClassExporterImporterTemplate.ContentHolderCommitListener

Field Summary

private String	_className
private static String	_rb
private static NMProjectConstants.OrgStructureInfo	orgTags

Fields inherited from class wt.ixb.publicforhandlers.ClassExporterImporterTemplate

Fields inherited from class wt.ixb.publicforhandlers.ClassExporterImporterTemplateGeneral

CONFLICT_RESOURCE

Constructor Summary

OrgStructureIXHandler()

Method Summary

Object	createObject(IxbElement elem, Importer imp) Creates new instance of Windchill object.
void	exportObject(Object obj, Exporter exp) Exports the specified object in context given by parameter exporter.
static void	exportOrgStructure(IxbElement elem, boolean doAcls, boolean doLinks, Exporter exporter)
static void	exportOrgStructure(IxbElement elem, boolean doAcls, Exporter exporter) OrgStructure OrgDomain* FolderStructure (OrgGroup?, ACLRule*)*
Object	findAmongExistingObjects(IxbElement obj, Importer imp) Implements typical way of finding whether object from given XML file exists already in Windchill database.
private String	getClassName()
int	getImportPriority() Return the import priority of the object type represented by this import handler.
Object	importElement(IxbElement elem, Importer imp) Imports XML element in context given by importer parameter.
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, 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

_rb

private static final String _rb

See Also:

Constant Field Values

_className

private String _className

orgTags

private static final NMProjectConstants.OrgStructureInfo orgTags

Constructor Detail

OrgStructureIXHandler

public OrgStructureIXHandler()

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

exportOrgStructure

public static void exportOrgStructure(IxbElement elem,
                                      boolean doAcls,
                                      Exporter exporter)
                               throws WTException

OrgStructure OrgDomain* FolderStructure (OrgGroup?, ACLRule*)*

Throws:

WTException

exportOrgStructure

public static void exportOrgStructure(IxbElement elem,
                                      boolean doAcls,
                                      boolean doLinks,
                                      Exporter exporter)
                               throws WTException

Throws:

WTException

createObject

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

Description copied from class: ClassExporterImporterTemplate

Creates new instance of Windchill object. Every class requires its own method to create object of this class. So, this method must be overriden by any class specific import handler

Supported API: true

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

getClassName

private String getClassName()

importElement

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

Description copied from class: ClassExporterImporterTemplate

Imports XML element in context given by importer parameter. Returns the imported object, which might be newly created or already existed in the datastore.

Supported API: true

Specified by:

importElement in interface ElementImporter

Overrides:

importElement in class ClassExporterImporterTemplate

Parameters:

elem -

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

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

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