oracle.odi.domain.project
Class OdiUserFunction

java.lang.Object
  oracle.odi.domain.support.BusinessObject
      oracle.odi.domain.support.AbstractRepositoryEntity
          oracle.odi.domain.support.AbstractOdiEntity
              oracle.odi.domain.project.OdiUserFunction

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IExportable, IOdiEntity, IRepositoryEntity, IWorkDevelopmentOdiEntity

public final class OdiUserFunction
extends oracle.odi.domain.support.AbstractOdiEntity
implements IExportable, IWorkDevelopmentOdiEntity

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.

• Global Scope OdiUserFunction are not bound to a given project and can be used in every object's expression.
• Project Scope 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.

Since:

11.1.1.3.0

See Also:

Serialized Form

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

getDescription

public java.lang.String getDescription()

Obtains the description of this OdiUserFunction.

Returns:

description

getFunctionString

public java.lang.String getFunctionString()

Obtains the function's string / text of this OdiUserFunction.

Returns:

function string

See Also:

setFunctionString(java.lang.String)

getGroupName

public java.lang.String getGroupName()

Obtains group name of this OdiUserFunction. OdiUserFunction can be grouped using this property.

Returns:

group name

getImplementations

public java.util.Collection<OdiUserFunctionImpl> getImplementations()

Obtains an unmodifiable collection of OdiUserFunctionImpls related to this OdiUserFunction.

Returns:

implementations

getInternalId

public java.io.Serializable getInternalId()

Description copied from interface: IRepositoryEntity

Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.

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.

Specified by:

getInternalId in interface IRepositoryEntity

Returns:

the persistence identity of this instance

getName

public java.lang.String getName()

Obtains the name of this OdiUserFunction.

Specified by:

getName in interface IOdiEntity

Overrides:

getName in class oracle.odi.domain.support.AbstractOdiEntity

Returns:

OdiUserFunction name

getProject

public OdiProject getProject()

Obtains the OdiProject this OdiUserFunction belongs to, or null if this is a global OdiUserFunction.

Returns:

the OdiProject this OdiUserFunction belongs to

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

Description copied from interface: IRepositoryEntity

Define a generic way to retrieve container for entities.

Specified by:

getSecurityContainer in interface IRepositoryEntity

Returns:

container entity

getUserFunctionId

public java.lang.Number getUserFunctionId()

Obtains the ID of this OdiUserFunction.

Returns:

OdiUserFunction ID

isGlobal

public boolean isGlobal()

Returns whether this OdiUserFunction is global, or not. (true if this is a Global Scope OdiUserFunction, false if this is a Project Scope OdiUserFunction).

Returns:

whether this OdiUserFunction is global, or not

isInstanceLevelSecurityNeeded

public boolean isInstanceLevelSecurityNeeded()

Description copied from interface: IOdiEntity

Internal: this method is for internal purpose and must not be considered as part of the public API.

Defines a method to capture the info on which object needs instance level privilege.

Specified by:

isInstanceLevelSecurityNeeded in interface IOdiEntity

Overrides:

isInstanceLevelSecurityNeeded in class oracle.odi.domain.support.AbstractOdiEntity

Returns:

true if instance level security needed, false otherwise

setFunctionString

public void setFunctionString(java.lang.String pFunctionString)

Specifies the function string value.

Parameters:

pFunctionString - a String specifying the function string value

See Also:

getFunctionString()