|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.odi.domain.support.BusinessObject oracle.odi.domain.support.AbstractRepositoryEntity oracle.odi.domain.support.AbstractOdiEntity oracle.odi.domain.project.OdiUserFunction
public final class OdiUserFunction
Represents design time metadata about a customized function that can be used in expressions of other objects such as
OdiInterface
, OdiUserProcedure
.
OdiUserFunction
is the root entity of OdiUserFunction
- OdiUserFunctionImpl
aggregate. Thus, an instance of OdiUserFunction
controls life cycle of OdiUserFunctionImpl
that belongs to it, and provides auditing informations about this aggregate.
There are two distinct scopes of OdiUserFunction
: Global
and Project
.
OdiUserFunction
are not bound to a given project and can be used in every
object's expression.
OdiUserFunction
are bound to a single OdiProject
and can only
be used inside expression of objects part of the same OdiProject
.
An OdiUserFunction
is independent from any physical information, thus is not tied to any
OdiTechnology
. As such, functionString
property is just a basic text pattern defining relevant
parameters and types. This functionString
will be replaced during code generation by actual implementation
according relevant technology where the expression will be executed (see OdiUserFunctionImpl
).
For now it is not possible to create an OdiUserFunction
.
Field Summary |
---|
Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity |
---|
STARTING_INTERNAL_VERSION |
Method Summary | |
---|---|
java.lang.String |
getDescription()
Obtains the description of this OdiUserFunction . |
java.lang.String |
getFunctionString()
Obtains the function's string / text of this OdiUserFunction . |
java.lang.String |
getGroupName()
Obtains group name of this OdiUserFunction . |
java.util.Collection<OdiUserFunctionImpl> |
getImplementations()
Obtains an unmodifiable collection of OdiUserFunctionImpls related to this OdiUserFunction . |
java.io.Serializable |
getInternalId()
Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used. |
java.lang.String |
getName()
Obtains the name of this OdiUserFunction . |
OdiProject |
getProject()
Obtains the OdiProject this OdiUserFunction belongs to, or null if this
is a global OdiUserFunction . |
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities. |
java.lang.Number |
getUserFunctionId()
Obtains the ID of this OdiUserFunction . |
boolean |
isGlobal()
Returns whether this OdiUserFunction is global, or not. |
boolean |
isInstanceLevelSecurityNeeded()
Internal: this method is for internal purpose and must not be considered as part of the public API. |
void |
setFunctionString(java.lang.String pFunctionString)
Specifies the function string value. |
Methods inherited from class oracle.odi.domain.support.AbstractOdiEntity |
---|
equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, isNew, toString |
Methods inherited from class oracle.odi.domain.support.BusinessObject |
---|
clone |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface oracle.odi.domain.IOdiEntity |
---|
getFirstDate, getFirstUser, getLastDate, getLastUser |
Method Detail |
---|
public java.lang.String getDescription()
OdiUserFunction
.
public java.lang.String getFunctionString()
OdiUserFunction
.
setFunctionString(java.lang.String)
public java.lang.String getGroupName()
OdiUserFunction
. OdiUserFunction
can be grouped
using this property.
public java.util.Collection<OdiUserFunctionImpl> getImplementations()
OdiUserFunctionImpls
related to this OdiUserFunction
.
public java.io.Serializable getInternalId()
IRepositoryEntity
Typically a subclass will delegate to a public
SomePrimitiveWrapper getId()
method. The necessity for the
getInternalId()
abstract method is solely because the
persistence layer needs a way of obtaining the identity irrespective of
the actual identity implementation choice.
Returning null
from this method will indicate the object has
never been saved. This will likely be relied on by some DAO
implementations.
getInternalId
in interface IRepositoryEntity
public java.lang.String getName()
OdiUserFunction
.
getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
OdiUserFunction
namepublic OdiProject getProject()
OdiProject
this OdiUserFunction
belongs to, or null if this
is a global OdiUserFunction
.
OdiProject
this OdiUserFunction
belongs topublic IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public java.lang.Number getUserFunctionId()
OdiUserFunction
.
OdiUserFunction
IDpublic boolean isGlobal()
OdiUserFunction
is global, or not.
(true if this is a Global Scope
OdiUserFunction
, false if this is a
Project Scope
OdiUserFunction
).
OdiUserFunction
is global, or notpublic boolean isInstanceLevelSecurityNeeded()
IOdiEntity
Defines a method to capture the info on which object needs instance level privilege.
isInstanceLevelSecurityNeeded
in interface IOdiEntity
isInstanceLevelSecurityNeeded
in class oracle.odi.domain.support.AbstractOdiEntity
true
if instance level security needed,
false
otherwisepublic void setFunctionString(java.lang.String pFunctionString)
pFunctionString
- a String specifying the function string valuegetFunctionString()
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |