wt.projmgmt.ix
Class ProjectConfigIxHandler

java.lang.Object
  wt.ixb.publicforhandlers.ClassExporterImporterTemplateGeneral
      wt.ixb.publicforhandlers.ClassExporterImporterTemplate
          wt.projmgmt.ix.ProjectConfigIxHandler

All Implemented Interfaces:

ClassExporter, ClassExporterImporter, ElementImporter

public class ProjectConfigIxHandler

extends ClassExporterImporterTemplate

This class deals with the import of the XML Element.

Nested Class Summary

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

ClassExporterImporterTemplate.ContentHolderCommitListener

Field Summary

static int	OBJECT_LEVEL
private static String	RESOURCE
static int	TYPE_LEVEL
private static boolean	VERBOSE

Fields inherited from class wt.ixb.publicforhandlers.ClassExporterImporterTemplate

Fields inherited from class wt.ixb.publicforhandlers.ClassExporterImporterTemplateGeneral

CONFLICT_RESOURCE

Constructor Summary

ProjectConfigIxHandler()

Method Summary

Object	createObject(IxbElement elem, Importer imp) ProjectConfig BaseProjectInfo projectMember* NmLoader*, OrgStructure? TypeBasedRule* SeedObjectRuleSet* createFromRule* ProductStructure? projectPlan* ProjectEnumType* DiscussionForumTemplate ForumSpec NotebookSpec?
void	exportObject(Object obj, Exporter exporter) Exports the specified object in context given by parameter exporter.
static void	exportProjectBaseInfo(Project2 project, IxbElement elem, Exporter exp)
void	exportProjectConfig(IxbElement project_elem, Exporter exporter) ProjectConfig BaseProjectInfo projectMember* NmLoader*, OrgStructure? TypeBasedRule* SeedObjectRuleSet* createFromRule* ProductStructure? projectPlan* ProjectEnumType* DiscussionForumTemplate ForumSpec NotebookSpec?
Object	findAmongExistingObjects(IxbElement parm1, Importer parm2) 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.
private void	importCreateFromRule(IxbElement elem, Importer imp)
private void	importDocTemplates(IxbElement elem, Importer imp)
private void	importForumSpec(IxbElement elem, Importer imp)
private void	importForumTemplates(IxbElement elem, Importer imp)
private void	importGuestMembership(IxbElement elem, Importer imp)
private void	importMembership(IxbElement elem, Importer imp)
private void	importNotebookSpec(IxbElement elem, Importer imp)
private void	importNotebookTemplates(IxbElement elem, Importer imp)
private void	importOrgStructure(IxbElement elem, Importer imp)
private void	importProductStructure(IxbElement elem, Importer imp)
private void	importProjectEnumType(IxbElement elem, Importer imp)
private void	importProjectPlan(IxbElement elem, Importer imp)
private void	importSeedObjectRules(IxbElement elem, Importer imp)
private void	importShareMaps(IxbElement elem, Importer imp)
private void	importTemplateDocs(IxbElement elem, Importer imp)
private void	importTypeBasedRules(IxbElement elem, Importer imp)
private void	importWorkflows(IxbElement elem, Importer imp)

Methods inherited from class wt.ixb.publicforhandlers.ClassExporterImporterTemplate

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

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

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

TYPE_LEVEL

public static final int TYPE_LEVEL

See Also:

Constant Field Values

OBJECT_LEVEL

public static final int OBJECT_LEVEL

See Also:

Constant Field Values

VERBOSE

private static final boolean VERBOSE

Constructor Detail

ProjectConfigIxHandler

public ProjectConfigIxHandler()

Method Detail

exportObject

public void exportObject(Object obj,
                         Exporter exporter)
                  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 -

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

Throws:

WTException

exportProjectConfig

public void exportProjectConfig(IxbElement project_elem,
                                Exporter exporter)
                         throws WTException

 ProjectConfig
     BaseProjectInfo
     projectMember*
     NmLoader*,
     OrgStructure?
     TypeBasedRule*
     SeedObjectRuleSet*
     createFromRule*
     ProductStructure?
     projectPlan*
     ProjectEnumType*
     DiscussionForumTemplate
     ForumSpec
     NotebookSpec?
 

Throws:

WTException

createObject

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

 ProjectConfig
     BaseProjectInfo
     projectMember*
     NmLoader*,
     OrgStructure?
     TypeBasedRule*
     SeedObjectRuleSet*
     createFromRule*
     ProductStructure?
     projectPlan*
     ProjectEnumType*
     DiscussionForumTemplate
     ForumSpec
     NotebookSpec?
 

Specified by:

createObject in class ClassExporterImporterTemplate

Parameters:

elem -

imp -

Returns:

Object

Throws:

WTException

importGuestMembership

private void importGuestMembership(IxbElement elem,
                                   Importer imp)
                            throws WTException

Throws:

WTException

importMembership

private void importMembership(IxbElement elem,
                              Importer imp)
                       throws WTException

Throws:

WTException

importOrgStructure

private void importOrgStructure(IxbElement elem,
                                Importer imp)
                         throws WTException

Throws:

WTException

importWorkflows

private void importWorkflows(IxbElement elem,
                             Importer imp)
                      throws WTException

Throws:

WTException

importTypeBasedRules

private void importTypeBasedRules(IxbElement elem,
                                  Importer imp)
                           throws WTException

Throws:

WTException

importSeedObjectRules

private void importSeedObjectRules(IxbElement elem,
                                   Importer imp)
                            throws WTException

Throws:

WTException

importCreateFromRule

private void importCreateFromRule(IxbElement elem,
                                  Importer imp)
                           throws WTException

Throws:

WTException

importProductStructure

private void importProductStructure(IxbElement elem,
                                    Importer imp)
                             throws WTException

Throws:

WTException

importShareMaps

private void importShareMaps(IxbElement elem,
                             Importer imp)
                      throws WTException

Throws:

WTException

importDocTemplates

private void importDocTemplates(IxbElement elem,
                                Importer imp)
                         throws WTException

Throws:

WTException

importTemplateDocs

private void importTemplateDocs(IxbElement elem,
                                Importer imp)
                         throws WTException

Throws:

WTException

importProjectPlan

private void importProjectPlan(IxbElement elem,
                               Importer imp)
                        throws WTException

Throws:

WTException

importProjectEnumType

private void importProjectEnumType(IxbElement elem,
                                   Importer imp)
                            throws WTException

Throws:

WTException

importForumTemplates

private void importForumTemplates(IxbElement elem,
                                  Importer imp)
                           throws WTException

Throws:

WTException

importNotebookTemplates

private void importNotebookTemplates(IxbElement elem,
                                     Importer imp)
                              throws WTException

Throws:

WTException

importForumSpec

private void importForumSpec(IxbElement elem,
                             Importer imp)
                      throws WTException

Throws:

WTException

importNotebookSpec

private void importNotebookSpec(IxbElement elem,
                                Importer imp)
                         throws WTException

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 parm1,
                                       Importer parm2)
                                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:

parm1 -

parm2 -

Returns:

Object

Throws:

WTException

exportProjectBaseInfo

public static void exportProjectBaseInfo(Project2 project,
                                         IxbElement elem,
                                         Exporter exp)
                                  throws WTException

Throws:

WTException