oracle.owb.oracle
Interface GatewayModule

All Superinterfaces:

CollectiveDerivationSource, Component, Extensible, Folder, IODerivationSource, Module, OWBNamedObject, PropertyOwner, Snapshotable, ValidatableObject

public interface GatewayModule

extends Module, CollectiveDerivationSource

GatewayModule is a specialized Module, which represents a logical Oracle gateway module. It can contain relational data entities like Table, View and Sequence.

Fields inherited from interface oracle.owb.data.Module

MODULE_FLATFILE, MODULE_GATEWAY_DB2, MODULE_GATEWAY_DRDA, MODULE_GATEWAY_INFORMIX, MODULE_GATEWAY_ODBC, MODULE_GATEWAY_OTHER, MODULE_GATEWAY_RDB, MODULE_GATEWAY_SQLSERVER, MODULE_GATEWAY_SYBASE, MODULE_GATEWAY_TERRADATA, MODULE_ORACLE, MODULE_ORACLE_APPS, MODULE_PROCESS_FLOW, MODULE_SAP

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

MAX_DEPENDENCY_DEPTH, MIN_DEPENDENCY_DEPTH

Method Summary

Sequence	createSequence(java.lang.String name) Creates a sequence in the Gateway Module.
Table	createTable(java.lang.String name) Creates a table in the Gateway Module.
View	createView(java.lang.String name) Creates a view in the Gateway Module.
Sequence	findSequence(java.lang.String name) Retrieve the sequence object based on its name.
Table	findTable(java.lang.String name) Retrieve the table object based on its name.
View	findView(java.lang.String name) Retrieve the view object based on its name.
DatatypeSet	getDatatypeSet() Get the datatype set for a Gateway Module.
java.lang.String	getGatewayType() Retreive the type of the gateway source this module represents.
Project	getProject() Retrieve the parent project for this Gateway Module.
java.lang.String[]	getSequenceNames() Get the names of all sequences owned by this Gateway module.
java.lang.String[]	getTableNames() Get the names of all tables owned by this Gateway module.
java.lang.String[]	getViewNames() Get the names of all views owned by this Gateway module.

Methods inherited from interface oracle.owb.data.Module

getLocation, setLocation

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

getProject

public Project getProject()

Retrieve the parent project for this Gateway Module.

Specified by:

getProject in interface Module

Returns:

the parent project.

getTableNames

public java.lang.String[] getTableNames()

Get the names of all tables owned by this Gateway module.

Returns:

an array of table names.

createTable

public Table createTable(java.lang.String name)
                  throws NameSpaceException,
                         InvalidFormatException

Creates a table in the Gateway Module.

Parameters:

name - the name of the new table.

Returns:

the newly created Table object.

Throws:

NameSpaceException - if table name is not unique.

InvalidFormatException - if the name is invalid.

findTable

public Table findTable(java.lang.String name)

Retrieve the table object based on its name.

Parameters:

name - the name of the table to find.

Returns:

the found Table object, or null if not found.

getViewNames

public java.lang.String[] getViewNames()

Get the names of all views owned by this Gateway module.

Returns:

an array of view names.

createView

public View createView(java.lang.String name)
                throws NameSpaceException,
                       InvalidFormatException

Creates a view in the Gateway Module.

Parameters:

name - the name of the new view .

Returns:

the newly created View object.

Throws:

NameSpaceException - if view name is not unique.

InvalidFormatException - if the name is invalid.

findView

public View findView(java.lang.String name)

Retrieve the view object based on its name.

Parameters:

name - the name of the view to find.

Returns:

the found View object, or null if not found.

getSequenceNames

public java.lang.String[] getSequenceNames()

Get the names of all sequences owned by this Gateway module.

Returns:

an array of sequence names.

createSequence

public Sequence createSequence(java.lang.String name)
                        throws NameSpaceException,
                               InvalidFormatException

Creates a sequence in the Gateway Module.

Parameters:

name - the name of the new sequence.

Returns:

the newly created Sequence object.

Throws:

NameSpaceException - if sequence name is not unique.

InvalidFormatException - if the name is invalid.

findSequence

public Sequence findSequence(java.lang.String name)

Retrieve the sequence object based on its name.

Parameters:

name - the name of the sequence to find.

Returns:

the found Sequence object, or null if not found.

getDatatypeSet

public DatatypeSet getDatatypeSet()

Get the datatype set for a Gateway Module.

Specified by:

getDatatypeSet in interface Module

Following copied from interface: oracle.owb.data.Module

Returns:

the data type set for this module

getGatewayType

public java.lang.String getGatewayType()

Retreive the type of the gateway source this module represents.

Returns:

the name of the gateway type.