oracle.owb.project
Interface Project

All Superinterfaces:

Component, Extensible, Folder, OWBNamedObject, PropertyOwner, Snapshotable, ValidatableObject

public interface Project

extends Folder, ValidatableObject, Extensible

Project is the highest level container of metadata objects in OWB. A project can contain Module, Location, RuntimeRepository and OWBCollection types of objects.

Field Summary

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

MAX_DEPENDENCY_DEPTH, MIN_DEPENDENCY_DEPTH

Method Summary

OWBCollection	createCollection(java.lang.String name) Create a Collection in this project.
FlatFileModule	createFlatFileModule(java.lang.String name) Creates a Flat File module within this project.
IntelligenceModule	createIntelligenceModule(java.lang.String name) Creates an Intelligence module within this project.
Location	createLocation(java.lang.String name, java.lang.String type, java.lang.String version) Creates a Location within this project, with the supplied name, type and version.
OracleModule	createOracleModule(java.lang.String name) Creates a Oracle module within this project.
ProcessFlowModule	createProcessFlowModule(java.lang.String name) Creates a Process Flow module within this project.
ReportModule	createReportModule(java.lang.String name) Creates a Report module within this project.
RuntimeRepository	createRuntimeRepository(java.lang.String name) Creates a Runtime Repository within this project, with the supplied name.
SAPModule	createSAPModule(java.lang.String name) Creates a SAP module within this project.
OWBCollection	findCollection(java.lang.String name) Find a collection by name in this project.
FlatFileModule	findFlatFileModule(java.lang.String name) Searches, based on name, for a Flat File module in this project.
GatewayModule	findGatewayModule(java.lang.String name) Searches, based on name, for a Gateway module in this project.
IntelligenceModule	findIntelligenceModule(java.lang.String name) Searches, based on name, for an Intelligence module in this project.
Location	findLocation(java.lang.String name) Searches, based on name, for a Location in this project.
OracleModule	findOracleModule(java.lang.String name) Searches, based on name, for a Oracle module in this project.
ProcessFlowModule	findProcessFlowModule(java.lang.String name) Searches, based on name, for a Process Flow module in this project.
ReportModule	findReportModule(java.lang.String name) Searches, based on name, for a Report module in this project.
RuntimeRepository	findRuntimeRepository(java.lang.String name) Searches, based on name, for a Runtime Repository object in this project.
SAPModule	findSAPModule(java.lang.String name) Searches, based on name, for a SAP module in this project.
java.lang.String[]	getCollectionNames() Retrieve a list of names of the existing collections within this project.
java.lang.String[]	getFlatFileModuleNames() Returns the names of the Flat File modules in this project.
java.lang.String[]	getGatewayModuleNames() Returns the names of the Gateway modules in this project.
java.lang.String[]	getIntelligenceModuleNames() Returns the names of the Intelligence modules in this project.
java.lang.String[]	getLocationNames() Returns the names of the Locations in this project.
java.lang.String[]	getLocationNames(java.lang.String type) Returns the names of the Locations in this project, with the supplied type.
java.lang.String[]	getOracleModuleNames() Returns the names of the Oracle modules in this project.
java.lang.String[]	getProcessFlowModuleNames() Returns the names of the Process Flow modules in this project.
java.lang.String[]	getReportModuleNames() Returns the names of the Report modules in this project.
java.lang.String[]	getRuntimeRepositoryNames() Returns the names of the Runtime Repositories in this project.
java.lang.String[]	getSAPModuleNames() Returns the names of the SAP modules in this project.

Methods inherited from interface oracle.owb.foundation.Folder

findChild, getContentTypes, getFolderContents, getFolderContentsOfType, isCascadeForSnapshot, lockShared, lockWithContents, reloadWithContents, setCascadeForSnapshot

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

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

Method Detail

getOracleModuleNames

public java.lang.String[] getOracleModuleNames()

Returns the names of the Oracle modules in this project.

Returns:

an array containing the names of the Oracle modules in this project

createOracleModule

public OracleModule createOracleModule(java.lang.String name)
                                throws NameSpaceException,
InvalidFormatException

Creates a Oracle module within this project.

Parameters:

name - the desired name for the Oracle module

Returns:

the newly created Oracle module

Throws:

NameSpaceException - if another OracleModule with the same name already exists in this project

InvalidFormatException - if the desired name does not satisfy the format requirements

findOracleModule

public OracleModule findOracleModule(java.lang.String name)

Searches, based on name, for a Oracle module in this project.

Parameters:

name - the Oracle module name to search for

Returns:

the Oracle module, or null if not found

getProcessFlowModuleNames

public java.lang.String[] getProcessFlowModuleNames()

Returns the names of the Process Flow modules in this project.

Returns:

an array containing the names of the Process Flow modules in this project

createProcessFlowModule

public ProcessFlowModule createProcessFlowModule(java.lang.String name)
                                          throws NameSpaceException,
InvalidFormatException

Creates a Process Flow module within this project.

Parameters:

name - the desired name for the Process Flow module

Returns:

the newly created Process Flow module

Throws:

NameSpaceException - if another ProcessFlowModule with the same name already exists in this project

InvalidFormatException - if the desired name does not satisfy the format requirements

findProcessFlowModule

public ProcessFlowModule findProcessFlowModule(java.lang.String name)

Searches, based on name, for a Process Flow module in this project.

Parameters:

name - the Process Flow module name to search for

Returns:

the Process Flow module, or null if not found

getCollectionNames

public java.lang.String[] getCollectionNames()

Retrieve a list of names of the existing collections within this project. The names can be used in the findCollection method to get a handle on the Collection object itself.

Returns:

an array containing the names of the existing collections in this project

createCollection

public OWBCollection createCollection(java.lang.String name)
                               throws NameSpaceException,
InvalidFormatException

Create a Collection in this project.

Parameters:

name - the name of the collection to create

Returns:

A handle to the newly created collection.

Throws:

NameSpaceException - if another OWBCollection with the same name already exists in this project

InvalidFormatException - if the desired name does not satisfy the format requirements

findCollection

public OWBCollection findCollection(java.lang.String name)

Find a collection by name in this project.

Parameters:

name - the name of the collection to find

Returns:

the found collection, or null if not found

getIntelligenceModuleNames

public java.lang.String[] getIntelligenceModuleNames()

Returns the names of the Intelligence modules in this project.

Returns:

an array containing the names of the Intelligence modules in this project

createIntelligenceModule

public IntelligenceModule createIntelligenceModule(java.lang.String name)
                                            throws NameSpaceException,
InvalidFormatException

Creates an Intelligence module within this project.

Parameters:

name - the desired name for the Intelligence module

Returns:

the newly created Intelligence module

Throws:

NameSpaceException - if another IntelligenceModule with the same name already exists in this project

InvalidFormatException - if the desired name does not satisfy the format requirements

findIntelligenceModule

public IntelligenceModule findIntelligenceModule(java.lang.String name)

Searches, based on name, for an Intelligence module in this project.

Parameters:

name - the Intelligence module name to search for

Returns:

the Intelligence module, or null if not found

getReportModuleNames

public java.lang.String[] getReportModuleNames()

Returns the names of the Report modules in this project.

Returns:

an array containing the names of the Report modules in this project

createReportModule

public ReportModule createReportModule(java.lang.String name)
                                throws NameSpaceException,
InvalidFormatException

Creates a Report module within this project.

Parameters:

name - the desired name for the Report module

Returns:

the newly created Report module

Throws:

NameSpaceException - if another ReportModule with the same name already exists in this project

InvalidFormatException - if the desired name does not satisfy the format requirements

findReportModule

public ReportModule findReportModule(java.lang.String name)

Searches, based on name, for a Report module in this project.

Parameters:

name - the Report module name to search for

Returns:

the Report module, or null if not found

getFlatFileModuleNames

public java.lang.String[] getFlatFileModuleNames()

Returns the names of the Flat File modules in this project.

Returns:

an array containing the names of the Flat File modules in this project

createFlatFileModule

public FlatFileModule createFlatFileModule(java.lang.String name)
                                    throws NameSpaceException,
InvalidFormatException

Creates a Flat File module within this project.

Parameters:

name - the desired name for the Flat File module

Returns:

the newly created Flat File module

Throws:

NameSpaceException - if another FlatFileModule with the same name already exists in this project

InvalidFormatException - if the desired name does not satisfy the format requirements

findFlatFileModule

public FlatFileModule findFlatFileModule(java.lang.String name)

Searches, based on name, for a Flat File module in this project.

Parameters:

name - the Flat File module name to search for

Returns:

the Flat File module, or null if not found

getSAPModuleNames

public java.lang.String[] getSAPModuleNames()

Returns the names of the SAP modules in this project.

Returns:

an array containing the names of the SAP modules in this project

createSAPModule

public SAPModule createSAPModule(java.lang.String name)
                          throws NameSpaceException,
InvalidFormatException

Creates a SAP module within this project.

Parameters:

name - the desired name for the SAP module

Returns:

the newly created SAP module

Throws:

NameSpaceException - if another SAPModule with the same name already exists in this project

InvalidFormatException - if the desired name does not satisfy the format requirements

findSAPModule

public SAPModule findSAPModule(java.lang.String name)

Searches, based on name, for a SAP module in this project.

Parameters:

name - the SAP module name to search for

Returns:

the SAP module, or null if not found

getGatewayModuleNames

public java.lang.String[] getGatewayModuleNames()

Returns the names of the Gateway modules in this project.

Returns:

an array containing the names of the Gateway modules in this project

findGatewayModule

public GatewayModule findGatewayModule(java.lang.String name)

Searches, based on name, for a Gateway module in this project.

Parameters:

name - the Gateway module name to search for

Returns:

the Gateway module, or null if not found

getLocationNames

public java.lang.String[] getLocationNames()

Returns the names of the Locations in this project.

Returns:

an array containing the names of the Locations in this project

getLocationNames

public java.lang.String[] getLocationNames(java.lang.String type)

Returns the names of the Locations in this project, with the supplied type.

Parameters:

type - the type of the Location

Returns:

an array containing the names of the Locations with the supplied type

createLocation

public Location createLocation(java.lang.String name,
                               java.lang.String type,
                               java.lang.String version)
                        throws NameSpaceException,
InvalidFormatException

Creates a Location within this project, with the supplied name, type and version.

Parameters:

name - the desired name for the Location

type - the type of the Location

version - the version of the Location

Returns:

the newly created Location

Throws:

NameSpaceException - if another Location with the same name already exists in this project

InvalidFormatException - if the desired name does not satisfy the format requirements

findLocation

public Location findLocation(java.lang.String name)

Searches, based on name, for a Location in this project.

Parameters:

name - the Location name to search for

Returns:

the Location, or null if not found

getRuntimeRepositoryNames

public java.lang.String[] getRuntimeRepositoryNames()

Returns the names of the Runtime Repositories in this project.

Returns:

an array containing the names of the Runtime Repositories in this project

createRuntimeRepository

public RuntimeRepository createRuntimeRepository(java.lang.String name)
                                          throws NameSpaceException,
InvalidFormatException

Creates a Runtime Repository within this project, with the supplied name.

Parameters:

name - the desired name

Returns:

the newly created Runtime Repository

Throws:

NameSpaceException - if another RuntimeRepository with the same name already exists in this project

InvalidFormatException - if the desired name does not satisfy the format requirements

findRuntimeRepository

public RuntimeRepository findRuntimeRepository(java.lang.String name)

Searches, based on name, for a Runtime Repository object in this project.

Parameters:

name - the Runtime Repository name to search for

Returns:

the Runtime Repository object, or null if not found