Oracle Warehouse Builder Java API Reference
10g Release 1 (10.1)

B12155-01

oracle.owb.transformation
Interface Package

All Superinterfaces:
CompilableObject, Component, Extensible, Folder, OWBNamedObject, PropertyOwner, Snapshotable, ValidatableObject

public interface Package
extends Folder, ValidatableObject, CompilableObject, Extensible

Package interface represents a library of functions. [More functionality description here! Explain standalone functions and procedures libraries!]


Field Summary

 

Fields inherited from interface oracle.owb.metadatamgmt.changemgmt.Snapshotable
MAX_DEPENDENCY_DEPTH, MIN_DEPENDENCY_DEPTH

 

Method Summary
 Function createFunction(java.lang.String name)
          Creates a new function in this Package.
 Procedure createProcedure(java.lang.String name)
          Creates a new procedure in this Package.
 Function findFunction(java.lang.String name)
          Finds a function in this Package.
 Function[] findFunctions(java.lang.String name)
          Search a function by name in this Package.
 Procedure findProcedure(java.lang.String name)
          Finds a procedure in this Package.
 Procedure[] findProcedures(java.lang.String name)
          Search a Procedure by name in this Package.
 java.lang.String[] getFunctionNames()
          Gets an array of function Name with signature.
 Language getLanguage()
          Returns the implementation language of the functions in this library.
 Module getModule()
          Returns the Parent Module of the Package.
 java.lang.String getPackageBody()
          Returns the implementation of the Imported Package Body.
 java.lang.String getPackageSpec()
          Returns the implementation of the Imported Package Spec.
 java.lang.String[] getProcedureNames()
          Gets an array of Procedure signatures.
 boolean isImported()
          Returns true if Package is Imported else false value.
 void setLanguage(Language language)
          Sets the implementation language of the functions in this library.
 void setPackageBody(java.lang.String s)
          Sets the implementation of the Imported Package Body.

 

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.compile.CompilableObject
compile

 

Methods inherited from interface oracle.owb.foundation.property.PropertyOwner
getDefaultPropertyValue, getLogicalPropertyKeys, getPhysicalPropertyKeys, getPropertyDomain, getPropertyKeys, getPropertyValue, getPropertyValueString, isLogicalProperty, isPhysicalProperty, isReadOnlyProperty, setPropertyValue, setPropertyValueByString

 

Method Detail

getModule

public Module getModule()
Returns the Parent Module of the Package.
Returns:
the parent Module

isImported

public boolean isImported()
Returns true if Package is Imported else false value.
Returns:
true or false

getLanguage

public Language getLanguage()
Returns the implementation language of the functions in this library.
Returns:
Language object

setLanguage

public void setLanguage(Language language)
Sets the implementation language of the functions in this library.

getPackageSpec

public java.lang.String getPackageSpec()
Returns the implementation of the Imported Package Spec.
Returns:
String object for Package spec

getPackageBody

public java.lang.String getPackageBody()
Returns the implementation of the Imported Package Body.
Returns:
String object for Package Body

setPackageBody

public void setPackageBody(java.lang.String s)
Sets the implementation of the Imported Package Body.

createFunction

public Function createFunction(java.lang.String name)
                        throws NameSpaceException,
InvalidFormatException
Creates a new function in this Package.
Parameters:
name - the name of the function to be created
NameSpaceException
InvalidFormatException

findFunction

public Function findFunction(java.lang.String name)
                      throws OWBException
Finds a function in this Package.
Parameters:
name - the name of the function to be found
Returns:
Function object Function
OWBException

getFunctionNames

public java.lang.String[] getFunctionNames()
Gets an array of function Name with signature.
Returns:
An array of function signatures in this Package

findFunctions

public Function[] findFunctions(java.lang.String name)
Search a function by name in this Package.
Parameters:
name - the name of the function to be found
Returns:
an array with all Function objects having the searched name. It returns an array because it is permitted to have multiple functions with the same name (function name can be overloaded).

createProcedure

public Procedure createProcedure(java.lang.String name)
                          throws NameSpaceException,
InvalidFormatException
Creates a new procedure in this Package.
Parameters:
name - the name of the procedure to be created
NameSpaceException
InvalidFormatException

findProcedure

public Procedure findProcedure(java.lang.String name)
                        throws OWBException
Finds a procedure in this Package.
Parameters:
name - the name of the procedure to be found
Returns:
Procedure object Procedure
OWBException

getProcedureNames

public java.lang.String[] getProcedureNames()
Gets an array of Procedure signatures.
Returns:
An array of String of Procedure signatures in this Package

findProcedures

public Procedure[] findProcedures(java.lang.String name)
Search a Procedure by name in this Package.
Parameters:
name - the name of the Procedure to be found
Returns:
an array with all Procedure having the searched name. It returns an array because it is permitted to have multiple Procedure with the same name (Procedure name can be overloaded).

Oracle Warehouse Builder Java API Reference
10g Release 1 (10.1)

B12155-01

Copyright © 2003, Oracle. All Rights Reserved.