oracle.owb.intelligence
Interface BusinessArea

All Superinterfaces:

Component, Extensible, IODerivationTarget, OWBNamedObject, PropertyOwner, Snapshotable, ValidatableObject

public interface BusinessArea

extends Component, Extensible, ValidatableObject, IODerivationTarget

A BusinessArea is a component of an Intelligence Module that collects together Query Objects and IO Function definitions that are relevant to a specific business interest.

Field Summary

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

MAX_DEPENDENCY_DEPTH, MIN_DEPENDENCY_DEPTH

Method Summary

void	addDerivationListener(DerivationListener l) addDerivationListener register DerivationListener.
BusinessAreaShortcut	createFunctionShortcut(IOFunction ioFunction, java.lang.String name) Creates a shortcut to an IO Function.
BusinessAreaShortcut	createQueryObjectShortcut(QueryObject queryObject, java.lang.String name) Creates a shortcut to a Query Object.
IODerivationTarget[]	deriveIntelligenceObject(IODerivationSource sourceObj) Carries out an Intelligence Object derivation from a single source object into this Business Area.
IODerivationTarget[]	deriveIntelligenceObjects(IODerivationSource[] sources) Carries out an Intelligence Object derivation from multiple source objects into this Business Area.
BusinessAreaShortcut	findShortcut(java.lang.String name) Search for a shortcut by name in this Business Area.
BusinessAreaShortcut[]	getFunctionShortcuts() Returns a list of the shortcuts to IO Functions in this Business Area.
IntelligenceModule	getIntelligenceModule() Returns the Intelligence Module this business area belongs to.
BusinessAreaShortcut[]	getQueryObjectShortcuts() Returns a list of the shortcuts to Query Objects in this Business Area.
void	removeDerivationListener(DerivationListener l) removeDerivationListener de-register DerivationListener.

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.foundation.property.PropertyOwner

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

Methods inherited from interface oracle.owb.compile.ValidatableObject

validate

Method Detail

deriveIntelligenceObject

public IODerivationTarget[] deriveIntelligenceObject(IODerivationSource sourceObj)

Carries out an Intelligence Object derivation from a single source object into this Business Area.

Parameters:

sourceObj - the individual or collective Derivation Source object that is to be the source of the derivation.

Returns:

an array of objects that are the result of the derivation

deriveIntelligenceObjects

public IODerivationTarget[] deriveIntelligenceObjects(IODerivationSource[] sources)

Carries out an Intelligence Object derivation from multiple source objects into this Business Area.

Parameters:

sources - an array of individual or collective Derivation Source objects that are to be the source of the derivation.

Returns:

an array of objects that are the result of the derivation

getIntelligenceModule

public IntelligenceModule getIntelligenceModule()

Returns the Intelligence Module this business area belongs to.

Returns:

the IntelligenceModule that owns this Business Area.

getQueryObjectShortcuts

public BusinessAreaShortcut[] getQueryObjectShortcuts()

Returns a list of the shortcuts to Query Objects in this Business Area.

Returns:

an array of BusinessAreaShortcuts that reference Query Objects.

createQueryObjectShortcut

public BusinessAreaShortcut createQueryObjectShortcut(QueryObject queryObject,
                                                      java.lang.String name)
                                               throws NameSpaceException,
InvalidFormatException

Creates a shortcut to a Query Object.

Parameters:

queryObject - the QueryObject which the shortcut is to reference

name - the name of the shortcut (if no name is supplied, a default name will be used)

Returns:

the newly created BusinessAreaShortcut

Throws:

NameSpaceException

InvalidFormatException

getFunctionShortcuts

public BusinessAreaShortcut[] getFunctionShortcuts()

Returns a list of the shortcuts to IO Functions in this Business Area.

Returns:

an array of BusinessAreaShortcuts that reference IO Functions.

createFunctionShortcut

public BusinessAreaShortcut createFunctionShortcut(IOFunction ioFunction,
                                                   java.lang.String name)
                                            throws NameSpaceException,
InvalidFormatException

Creates a shortcut to an IO Function.

Parameters:

ioFunction - the IOFunction which the shortcut is to reference

name - the name of the shortcut (if no name is supplied, a default name will be used)

Returns:

the newly created BusinessAreaShortcut

Throws:

NameSpaceException

InvalidFormatException

findShortcut

public BusinessAreaShortcut findShortcut(java.lang.String name)

Search for a shortcut by name in this Business Area.

Parameters:

name - the name of the Business Area Shortcut to be found

Returns:

the BusinessAreaShortcut if found, null otherwise

addDerivationListener

public void addDerivationListener(DerivationListener l)

addDerivationListener register DerivationListener.

Parameters:

l - Object implementing the DerivationListener interface

See Also:

removeDerivationListener(oracle.owb.intelligence.DerivationListener)

removeDerivationListener

public void removeDerivationListener(DerivationListener l)

removeDerivationListener de-register DerivationListener.

Parameters:

l - listener to remove

See Also:

addDerivationListener(oracle.owb.intelligence.DerivationListener)