oracle.owb.project
Interface OWBCollection

All Superinterfaces:

CollectiveDerivationSource, CompilableObject, Component, Extensible, IODerivationSource, OWBNamedObject, PropertyOwner, Snapshotable, ValidatableObject

public interface OWBCollection

extends Component, ValidatableObject, CompilableObject, Extensible, CollectiveDerivationSource

OWBCollection is an arbitrary grouping mechanism. OWBCollection can refer to other OWBCollections, Modules and other Components.

Field Summary

Fields inherited from interface oracle.owb.metadatamgmt.changemgmt.Snapshotable

MAX_DEPENDENCY_DEPTH, MIN_DEPENDENCY_DEPTH

Method Summary

void	addComponentReference(Component component) Add a component reference to this collection.
Component[]	getComponents() Retrieve an array of handles to the objects which are in the collection.
Component[]	getComponents(ClassDefinition typ) Retrieve an array of handles to the objects which are in the collection.
Project	getProject() Retrieve the project for this collection.
void	reconcile() Reconciling the collection will compress the collection and remove references which refer to objects which have now been removed.
void	removeComponentReference(Component component) Remove an object reference from the collection, passing the object to be removed.

Methods inherited from interface oracle.owb.foundation.Component

getOwningFolder, isReloadNeeded, lock, reload, unlock

Methods inherited from interface oracle.owb.foundation.OWBNamedObject

delete, getBusinessName, getClassDefinition, getComponent, getDescription, getName, getUOID, isDeletable, isEditable, isRenamable, setBusinessName, setDescription, setName

Methods inherited from interface oracle.owb.metadatamgmt.changemgmt.Snapshotable

compare, compare, compare, compare, createSnapshot, createSnapshot, createSnapshotWithDependeeComponents, createSnapshotWithDependeeComponents, getSnapshots

Methods inherited from interface oracle.owb.compile.ValidatableObject

validate

Methods inherited from interface oracle.owb.compile.CompilableObject

compile

Methods inherited from interface oracle.owb.foundation.property.PropertyOwner

getDefaultPropertyValue, getLogicalPropertyKeys, getPhysicalPropertyKeys, getPropertyDomain, getPropertyKeys, getPropertyValue, getPropertyValueString, isLogicalProperty, isPhysicalProperty, isReadOnlyProperty, setPropertyValue, setPropertyValueByString

Method Detail

getProject

public Project getProject()

Retrieve the project for this collection.

Returns:

The project this collection is contained within.

addComponentReference

public void addComponentReference(Component component)

Add a component reference to this collection. This method will update the collection object.

Parameters:

component - add reference to component in collection.

removeComponentReference

public void removeComponentReference(Component component)

Remove an object reference from the collection, passing the object to be removed. This method will update the object.

Parameters:

component - remove reference to component in collection.

getComponents

public Component[] getComponents()

Retrieve an array of handles to the objects which are in the collection.

Returns:

The array of components referenced from within this collection.

getComponents

public Component[] getComponents(ClassDefinition typ)

Retrieve an array of handles to the objects which are in the collection. The objects are filtered by the type which is passed as a parameter. So it is possible to list only the tables for example, which the collection references.

Parameters:

typ - The type of object to return references for.

Returns:

The array of components referenced from within this collection.

reconcile

public void reconcile()

Reconciling the collection will compress the collection and remove references which refer to objects which have now been removed. This is an update operation.