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

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

Method Summary

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() Returns the ESIMap identified by the value of the mapFileName attribute.
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, toString, wait, wait, wait

Constructor Detail

ESIMapInfo

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

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

Supported API: true

Parameters:

mapFileName -

elementMetaName -

keyAttributes -

Method Detail

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

Returns the ESIMap identified by the value of the mapFileName attribute.

Supported API: true

Returns:

ESIMap

Throws:

ESIMapException