oracle.owb.foundation
Interface Component

All Superinterfaces:

OWBNamedObject, Snapshotable

All Known Subinterfaces:

AdvancedQueue, BaseLocation, BusinessArea, Connector, Cube, Dimension, ExternalTable, FlatFile, FlatFileModule, Folder, Function, GatewayModule, IntelligenceModule, IOFunction, Location, Map, MaterializedView, Module, ObjectType, OracleModule, OWBCollection, Package, Procedure, ProcessFlow, ProcessFlowModule, ProcessFlowPackage, Project, QueryObject, Report, ReportGroup, ReportModule, RuntimeRepository, SAPModule, Sequence, Table, TransformationModule, View

public interface Component

extends OWBNamedObject, Snapshotable

A Component is a large-grained metadata object, which usually aggregates multiple objects. A component is the smallest independent unit of locking and delivery from repository. Components usually correspond to business meaningful entities like Table, View, Dimension, Cube, etc.

Field Summary

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

MAX_DEPENDENCY_DEPTH, MIN_DEPENDENCY_DEPTH

Method Summary

Folder	getOwningFolder() Return the parent folder for this component.
boolean	isReloadNeeded() Return whether this component needs to be reloaded (synchronized) from the repository.
void	lock() Locks the component.
void	reload() Reload (synchronize) this component from the repository.
void	unlock() Cancels the last lock request performed on this component.

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

Method Detail

getOwningFolder

public Folder getOwningFolder()

Return the parent folder for this component.

Returns:

the parent folder or null if it has no parent.

lock

public void lock()
          throws LockException

Locks the component. This method should be explicitly called before modifying a component or any of its aggregated objects.

Throws:

LockException - if the lock on the component could not be obtained (for example, some other user already has the lock on the component)

unlock

public void unlock()
            throws LockException

Cancels the last lock request performed on this component. As a result of this operation, the lock on the component will be released if and only if: no other lock operations have been performed on the component AND the transaction that modified the component has been commited or rolled back. In other words, to release the lock on a component one should call the unlock method for each locking method previously called on the component, AND to commit or rollback the transaction that modified the object (if any).

Throws:

LockException - if the component is not locked

isReloadNeeded

public boolean isReloadNeeded()

Return whether this component needs to be reloaded (synchronized) from the repository. The component may need to be reloaded because some other user may have modified it since the last time this user loaded it.

Returns:

true if the component needs to be reloaded, and false otherwise.

reload

public void reload()

Reload (synchronize) this component from the repository. The component may need to be reloaded because some other user may have modified it since the last time this user loaded it.