Package com.ptc.windchill.esi.map

Class ESIMapInfo

java.lang.Object

com.ptc.windchill.esi.map.ESIMapInfo

public final class ESIMapInfo
extends Object

Container for ESIMap information.

Supported API: true

Extendable: false

Constructor Summary

Constructors

Constructor	Description
ESIMapInfo(String mapFileName, String elementMetaName, String[] keyAttributes, Boolean isEnterpriseDataMergeWithElement)	Only constructor for the object, insures that the object is initialized properly.

Method Summary

Modifier and Type	Method	Description
String	getElementMetaName()	Gets the value of the attribute: elementMetaName; When mapping the object, the output Info*Engine Element metadata element "com.infoengine.xml.esi" is to be assigned the value of this attribute.
String[]	getKeyAttributes()	Gets the value of the attribute: keyAttributes; The names of the key attributes used to filter out duplicates.
ESIMap	getMap()	Fetches the ESIMap object identified by the value in mapFileName using an ESIMapManager instance and returns the thus fetched ESIMap object to the caller.
String	getMapFileName()	Gets the value of the attribute: mapFileName; The location of the ESIMap source file.

Methods inherited from class java.lang.Object

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

Constructor Details

ESIMapInfo

public ESIMapInfo(String mapFileName,
 String elementMetaName,
 String[] keyAttributes,
 Boolean isEnterpriseDataMergeWithElement)

Only constructor for the object, insures that the object is initialized properly.

Supported API: true

Parameters:

mapFileName -

elementMetaName -

keyAttributes -

Method Details

getMapFileName

public String getMapFileName()

Gets the value of the attribute: mapFileName; The location of the ESIMap source file.

Supported API: true

Returns:

String

getElementMetaName

public String getElementMetaName()

Gets the value of the attribute: elementMetaName; When mapping the object, the output Info*Engine Element metadata element "com.infoengine.xml.esi" is to be assigned the value of this attribute. This causes the I*E SOAP servlet to render the output XML element name equal to this value.

Supported API: true

Returns:

String

getKeyAttributes

public String[] getKeyAttributes()

Gets the value of the attribute: keyAttributes; The names of the key attributes used to filter out duplicates. If null, the elements are not filtered.

Supported API: true

Returns:

String[]

getMap

public ESIMap getMap()
              throws ESIMapException

Fetches the ESIMap object identified by the value in mapFileName using an ESIMapManager instance and returns the thus fetched ESIMap object to the caller.

Supported API: true

Returns:

The value returned by the API that is invoked on the ESIMapManager instance for fetching the output.

Throws:

ESIMapException - If the API invoked on the ESIMapManager instance threw this exception.