com.ptc.windchill.esi.map
Class ESIGroupInfo

java.lang.Object
  com.ptc.windchill.esi.map.ESIGroupInfo

public final class ESIGroupInfo

extends Object

Manages information about Info*Engine Groups which are to be built by the VDB builder.

Supported API: true

Extendable: false

Field Summary

private static String	CLASSNAME
private String	logicalName
private ESIMapInfo	mapInfo
private String	physicalName
private boolean	releaseActivityNeeded
private String	releaseClass
private static String	RESOURCE

Constructor Summary

(package private)

ESIGroupInfo(String logicalName, String physicalName, ESIMapInfo mapInfo, boolean isReleaseActivityNeeded, String releaseClass) Only constructor of the class, insures that the object is properly initialized.

Method Summary

String	getLogicalName() Gets the value of the attribute: logicalName; The logical name to be used by the clients of this object when obtaining the object from the Group Information Manager.
ESIMapInfo	getMapInfo() Gets the object for the association that plays role: mapInfo.
Collection	getMapSourceAttributes() Returns a collection of Strings that represent the names of the source attributes.
String	getPhysicalName() Gets the value of the attribute: physicalName; The actual name of the Info*Engine group that will be built by the VDB builder.
String	getReleaseClass() Gets the value of the attribute: releaseClass; Value to assign to a ReleaseActivity.releaseClass, when the ReleaseActivity is created.
boolean	isReleaseActivityNeeded() Gets the value of the attribute: releaseActivityNeeded; Are pending ReleaseActivity objects to be created when the Group's contents are processed by the VDB builder? Supported API: false
void	setReleaseActivityNeeded(boolean a_ReleaseActivityNeeded) Sets the value of the attribute: releaseActivityNeeded; Are pending ReleaseActivity objects to be created when the Group's contents are processed by the VDB builder? Supported API: false

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

CLASSNAME

private static final String CLASSNAME

logicalName

private String logicalName

physicalName

private String physicalName

releaseActivityNeeded

private boolean releaseActivityNeeded

releaseClass

private String releaseClass

mapInfo

private ESIMapInfo mapInfo

Constructor Detail

ESIGroupInfo

ESIGroupInfo(String logicalName,
             String physicalName,
             ESIMapInfo mapInfo,
             boolean isReleaseActivityNeeded,
             String releaseClass)

Only constructor of the class, insures that the object is properly initialized. Hide it from objects outside of this package, so that clients are forced to use the GroupInfoManager.

Supported API: true

Parameters:

logicalName - The logical name for clients to use when accessing this object.

physicalName - The actual name of the VDB Group to be created.

mapInfo - The ESIMapInfo to use.

isReleaseActivityNeeded - Should ESI create a pending release activity for objects in this group?

releaseClass -

Method Detail

getLogicalName

public String getLogicalName()

Gets the value of the attribute: logicalName; The logical name to be used by the clients of this object when obtaining the object from the Group Information Manager.

Supported API: true

Returns:

String

getPhysicalName

public String getPhysicalName()

Gets the value of the attribute: physicalName; The actual name of the Info*Engine group that will be built by the VDB builder.

Supported API: true

Returns:

String

isReleaseActivityNeeded

public boolean isReleaseActivityNeeded()

Gets the value of the attribute: releaseActivityNeeded; Are pending ReleaseActivity objects to be created when the Group's contents are processed by the VDB builder?

Supported API: false

Returns:

boolean

setReleaseActivityNeeded

public void setReleaseActivityNeeded(boolean a_ReleaseActivityNeeded)
                              throws WTPropertyVetoException

Sets the value of the attribute: releaseActivityNeeded; Are pending ReleaseActivity objects to be created when the Group's contents are processed by the VDB builder?

Supported API: false

Parameters:

a_ReleaseActivityNeeded -

Throws:

WTPropertyVetoException

getReleaseClass

public String getReleaseClass()

Gets the value of the attribute: releaseClass; Value to assign to a ReleaseActivity.releaseClass, when the ReleaseActivity is created.

Supported API: true

Returns:

String

getMapInfo

public ESIMapInfo getMapInfo()

Gets the object for the association that plays role: mapInfo.

Supported API: true

Returns:

ESIMapInfo

getMapSourceAttributes

public Collection getMapSourceAttributes()
                                  throws ESIMapException

Returns a collection of Strings that represent the names of the source attributes.

Supported API: true

Returns:

Collection

Throws:

ESIMapException