com.ptc.windchill.esi.rnd
Class VdbBuilderImpl

java.lang.Object
  com.ptc.windchill.esi.rnd.VdbBuilderImpl

All Implemented Interfaces:

VdbBuilder, Externalizable, Serializable

public class VdbBuilderImpl
extends Object
implements VdbBuilder, Externalizable

The default ESI VdbBuilder implementation.

Supported API: true

Extendable: true

See Also:

Serialized Form

Nested Class Summary

static class

com.ptc.windchill.esi.rnd.VdbBuilderImpl.ElementKey

Method Summary

void	addElement(String groupName, com.infoengine.object.factory.Element element, Persistable persistable, Persistable[] dependents, Collection targets) Creates a VdbElement containing an I*E Element and a Persistable.
com.infoengine.object.IeCollection	asVDB() Create the VDB from the contents of the VdbGroups that were built.
protected VdbGroup	getGroup(String groupName) Returns the VdbGroup identified by the groupName attribute.
String	getTransactionNumber() Gets the value of the attribute: transactionNumber; The number of an ESI transaction.
void	initialize(String transactionNumber) Make sure the object is ready for requests.
boolean	isEmpty() Returns a boolean response based on if groups are empty in the IeCollection.

Methods inherited from class java.lang.Object

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

Method Detail

getTransactionNumber

public String getTransactionNumber()

Gets the value of the attribute: transactionNumber; The number of an ESI transaction.

Supported API: true

Specified by:

getTransactionNumber in interface VdbBuilder

Returns:

String

initialize

public void initialize(String transactionNumber)

Make sure the object is ready for requests. Stores the argument in the transactionNumber attribute.

Supported API: true

Specified by:

initialize in interface VdbBuilder

Parameters:

transactionNumber -

getGroup

protected VdbGroup getGroup(String groupName)

Returns the VdbGroup identified by the groupName attribute. Obtains the result from the associated VdbContainer.

Supported API: true

Parameters:

groupName -

Returns:

VdbGroup

addElement

public void addElement(String groupName,
                       com.infoengine.object.factory.Element element,
                       Persistable persistable,
                       Persistable[] dependents,
                       Collection targets)
                throws com.ptc.windchill.esi.rnd.ESIRendererException

Creates a VdbElement containing an I*E Element and a Persistable. Adds the VdbElement to a VdbGroup. The VdbGroup is logically identified by the groupName argument.

Supported API: true

Specified by:

addElement in interface VdbBuilder

Parameters:

groupName - The logical group to which the element argument is to be added.

element - The I*E element that is to be added to the group.

persistable - The persistable, of which the element is a representation. May be null.

dependents - Dependent persistables, also of which the element is a representation. May be null.

targets - Collection of ESITarget objects.

Throws:

com.ptc.windchill.esi.rnd.ESIRendererException

asVDB

public com.infoengine.object.IeCollection asVDB()
                                         throws com.ptc.windchill.esi.rnd.ESIRendererException

Create the VDB from the contents of the VdbGroups that were built. If transactionID is not null, identify the objects to be marked as pending and ask the transaction utility to mark them. Return the result of VdbContain.asVDB().

Supported API: true

Specified by:

asVDB in interface VdbBuilder

Returns:

IeCollection

Throws:

com.ptc.windchill.esi.rnd.ESIRendererException

isEmpty

public boolean isEmpty()
                throws com.ptc.windchill.esi.rnd.ESIRendererException

Returns a boolean response based on if groups are empty in the IeCollection.

Supported API: true

Specified by:

isEmpty in interface VdbBuilder

Returns:

boolean

Throws:

com.ptc.windchill.esi.rnd.ESIRendererException