|
Oracle Warehouse Builder Java API Reference 10g Release 1 (10.1) B12155-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A Folder
is a special type of Component
, which can contain other components. Examples of folders are: projects, modules, function libraries, etc.
Field Summary |
Fields inherited from interface oracle.owb.metadatamgmt.changemgmt.Snapshotable |
MAX_DEPENDENCY_DEPTH, MIN_DEPENDENCY_DEPTH |
Method Summary | |
Component |
findChild(java.lang.String name, ClassDefinition filterType) Finds the child component with the specified name and type. |
ClassDefinition[] |
getContentTypes() Returns the list of component types allowed in this folder. |
Component[] |
getFolderContents() Returns the contents of this folder as an array of components. |
Component[] |
getFolderContentsOfType(ClassDefinition filterType) Returns the components contained in this folder, which are of the specified type. |
boolean |
isCascadeForSnapshot() Returns whether the children components will be included in any Snapshot taken on this folder. |
void |
lockShared() This method attempts to aquire a shared lock on the folder. |
void |
lockWithContents() Locks this folder together with all its contained components. |
void |
reloadWithContents() Reload (synchronize) this folder, together with all its contents, from the repository. |
void |
setCascadeForSnapshot(boolean shouldCascade) Setting this flag indicates whether this Snapshotable should include all its children or not while creating snapshot. |
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 |
Method Detail |
public Component[] getFolderContents()
public Component[] getFolderContentsOfType(ClassDefinition filterType)
filterType
- the type of the requested componentspublic ClassDefinition[] getContentTypes()
public Component findChild(java.lang.String name, ClassDefinition filterType)
name
- the name of the requested componentfilterType
- the type of the requested componentnull
otherwise.public void lockWithContents() throws LockException
LockException
- if the lock could not be obtained (because, for example, some other user already has a lock on the folder or on any of the contained components)public void lockShared() throws LockException
LockException
- if the shared lock could not be obtainedpublic void reloadWithContents()
Component.reload()
public void setCascadeForSnapshot(boolean shouldCascade)
Snapshotable
. For example, if this is an Oracle module, and cascade is set to false, then tables, views will not be included into Snapshot, else Oracle module and all of its contained objects will be included into Snapshot. Before creating a Snapshot on this component, this method should be called to control cascade behavior.shouldCascade
- if true
, Snapshot will include children Components, otherwise Snapshot will exclude children Components.public boolean isCascadeForSnapshot()
true
if Snapshot is required to include children components, and false
otherwise.setCascadeForSnapshot(boolean)
|
Oracle Warehouse Builder Java API Reference 10g Release 1 (10.1) B12155-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |