com.ptc.windchill.esi.rnd
Interface VdbBuilder

All Known Implementing Classes:

VdbBuilderImpl

public interface VdbBuilder

Declares the API for VDB builders.

Supported API: true

Extendable: false

Method Summary

void	addElement(String groupName, Element element, Persistable persistable, Collection targets) Adds an Element to a collection of elements.
void	addElement(String groupName, Element element, Persistable persistable, Persistable[] dependents, Collection targets) Adds an Element to a collection of elements.
IeCollection	asVDB() Return the results of the calculations that were performed on the elements passed into addElement().
String	getTransactionNumber() Return the value of the transaction number that was passed to the initialize() method.
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.

Method Detail

initialize

public void initialize(String transactionNumber)

Make sure the object is ready for requests. It is assumed that the implementation class will have a transactionID and methods that use the transaction ID.

Supported API: true

Parameters:

transactionNumber -

getTransactionNumber

public String getTransactionNumber()

Return the value of the transaction number that was passed to the initialize() method.

Supported API: true

Returns:

String

addElement

public void addElement(String groupName,
                       Element element,
                       Persistable persistable,
                       Collection targets)
                throws ESIRendererException

Adds an Element to a collection of elements. The collection is logically identified by the groupName argument.

Supported API: true

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.

targets - Collection of ESITarget objects.

Throws:

ESIRendererException

addElement

public void addElement(String groupName,
                       Element element,
                       Persistable persistable,
                       Persistable[] dependents,
                       Collection targets)
                throws ESIRendererException

Adds an Element to a collection of elements. The collection is logically identified by the groupName argument.

Supported API: true

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:

ESIRendererException

asVDB

public IeCollection asVDB()
                   throws ESIRendererException

Return the results of the calculations that were performed on the elements passed into addElement().

Supported API: true

Returns:

IeCollection

Throws:

ESIRendererException

isEmpty

public boolean isEmpty()
                throws ESIRendererException

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

Supported API: true

Returns:

boolean

Throws:

ESIRendererException