Package com.ptc.windchill.esi.rnd

Class VdbContainer

java.lang.Object

com.ptc.windchill.esi.rnd.VdbContainer

public final class VdbContainer
extends Object

Manages a collection of VdbGroups and renders them as an Info*Engine IeCollection.

Supported API: true

Extendable: false

Method Summary

Modifier and Type	Method	Description
void	addGroup(String name, VdbGroup group)	Adds a VdbGroup to the groups collection.
com.infoengine.object.IeCollection	asVDB()	Returns the VdbGroups in the HashMap in groups as an Info*Engine IeCollection.
VdbGroup	getGroup(String name)	Returns a VdbGroup from the groups collection.
Collection	getGroups()	Returns the contents of the groups collection.
void	removeGroup(String name)	Removes a VdbGroup from the groups collection if one exists in the collection with a logical name that is equal to the argument.

Methods inherited from class java.lang.Object

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

Method Details

addGroup

public void addGroup(String name,
 VdbGroup group)
              throws MissingParameterException

Adds a VdbGroup to the groups collection. Uses the logical name of the group that is passed in the name argument.
Throws a MissingParameterException if either argument is null.

Supported API: true

Parameters:

name - The logical name of the group.

group - The VdbGroup to add to the groups collection.

Throws:

MissingParameterException

removeGroup

public void removeGroup(String name)

Removes a VdbGroup from the groups collection if one exists in the collection with a logical name that is equal to the argument.

Supported API: true

Parameters:

name - The logical name of the group to remove.

getGroup

public VdbGroup getGroup(String name)

Returns a VdbGroup from the groups collection. Returns null if the group with the supplied name is not found in the collection.

Supported API: true

Parameters:

name - The logical name of the group to obtain.

Returns:

VdbGroup

getGroups

public Collection getGroups()

Returns the contents of the groups collection.

Supported API: true

Returns:

Collection

asVDB

public com.infoengine.object.IeCollection asVDB()

Returns the VdbGroups in the HashMap in groups as an Info*Engine IeCollection.

Supported API: true

Returns:

IeCollection