wt.ixb.handlers.netmarkets
Class NMProjectMembershipIXHandler

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

All Implemented Interfaces:

ClassExporter, ClassExporterImporter, ElementImporter

public class NMProjectMembershipIXHandler

extends ClassExporterImporterTemplate

NMProjectMembershipIXHandler is responsible for the import of members to a project and the assigning of their roles. Export is not supported for this clsas. This handler handles the xml tag.

Nested Class Summary

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

ClassExporterImporterTemplate.ContentHolderCommitListener

Field Summary

private static String	_rb
private static NMProjectConstants.ProjectMemberInfo	memberTags

Fields inherited from class wt.ixb.publicforhandlers.ClassExporterImporterTemplate

Fields inherited from class wt.ixb.publicforhandlers.ClassExporterImporterTemplateGeneral

CONFLICT_RESOURCE

Constructor Summary

NMProjectMembershipIXHandler()

Method Summary

Object	createObject(IxbElement elem, Importer imp)
void	exportObject(Object obj, Exporter exp) Exports the specified object in context given by parameter exporter.
static void	exportProjectMember(ContainerTeamManaged project, Role role, IxbElement elem, Exporter exporter)
Object	findAmongExistingObjects(IxbElement parm1, Importer parm2) Implements typical way of finding whether object from given XML file exists already in Windchill database.
private WTGroup	getGroupFromTag(IxbElement elem, Importer imp)
int	getImportPriority() Return the import priority of the object type represented by this import handler.
private ObjectIdentifier	getOid(Object obj)
static TeamExportHolder	getTeamHolder(ContainerTeamManaged ctm)
private EmailUser	getUserFromTag(IxbElement elem, WTContainerRef contRef)
Object	storeObject(Object obj, IxbElement elem, Importer imp) Store is over-ridden because the service will store the membership for us.

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

_rb

private static final String _rb

See Also:

Constant Field Values

memberTags

private static final NMProjectConstants.ProjectMemberInfo memberTags

Constructor Detail

NMProjectMembershipIXHandler

public NMProjectMembershipIXHandler()

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

exportProjectMember

public static void exportProjectMember(ContainerTeamManaged project,
                                       Role role,
                                       IxbElement elem,
                                       Exporter exporter)
                                throws WTException

Throws:

WTException

createObject

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

Specified by:

createObject in class ClassExporterImporterTemplate

Parameters:

elem -

imp -

Returns:

Object

Throws:

WTException

getUserFromTag

private EmailUser getUserFromTag(IxbElement elem,
                                 WTContainerRef contRef)
                          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

getTeamHolder

public static TeamExportHolder getTeamHolder(ContainerTeamManaged ctm)
                                      throws WTException

Throws:

WTException

getGroupFromTag

private WTGroup getGroupFromTag(IxbElement elem,
                                Importer imp)
                         throws WTException

Throws:

WTException

getOid

private ObjectIdentifier getOid(Object obj)
                         throws WTException

Throws:

WTException

storeObject

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

Store is over-ridden because the service will store the membership for us. During create.

Overrides:

storeObject in class ClassExporterImporterTemplate

Parameters:

obj -

elem -

imp -

Returns:

Object

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