oracle.odi.domain.topology

Class OdiFlexField

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.support.AbstractOdiEntity

oracle.odi.domain.topology.OdiFlexField

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IFlexField, IMasterOdiEntity, IOdiEntity, IRepositoryEntity

public class OdiFlexField
extends oracle.odi.domain.support.AbstractOdiEntity
implements IMasterOdiEntity, IFlexField

An ODI Flex Field enabling generic/flexible definition of custom informations for an ODI entity (aka IOdiEntity).

Since:

11.1.1.3.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OdiFlexField.FlexFieldType Type safe enum for types of OdiFlexField.

Field Summary

Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity

STARTING_INTERNAL_VERSION

Constructor Summary

Constructors

Constructor and Description
OdiFlexField(java.lang.Class pFlexFieldUserClass, java.lang.String pCode) Create a new OdiFlexField.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCode() Obtains this OdiFlexField's code.
java.lang.Object	getDefaultValue() Obtains the default value.
java.lang.Number	getFlexFieldId() This OdiFlexField ID.
OdiFlexField.FlexFieldType	getFlexFieldType() Obtains the type of this OdiFlexField.
java.lang.Class	getFlexFieldUserClass() Get the implementation of IFlexFieldUser for which this FlexField is relevant.
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 this OdiFlexField's name.
int	getOrder() Obtains this OdiFlexField's order.
OdiTechnology	getTechnology() Get the technology this FlexField applies, or null if this FlexField applies to all technologies or is not technology related.
void	setDefaultValue(java.lang.Object pDefaultValue) Defines the default value for this OdiFlexField.
void	setFlexFieldType(OdiFlexField.FlexFieldType pFlexFieldType) Defines the type of this OdiFlexField.
void	setName(java.lang.String pName) Defines the name of this OdiFlexField.
void	setOrder(int pOrder) Defines this OdiFlexField's order.
void	setTechnology(OdiTechnology pTechnology) The technology to which this FlexField applies.

Methods inherited from class oracle.odi.domain.support.AbstractOdiEntity

getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, isInstanceLevelSecurityNeeded, isNew, preCommit, toString

Methods inherited from class oracle.odi.domain.support.AbstractRepositoryEntity

equals, getGlobalId, getNumericId, getParent, hashCode

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, isInstanceLevelSecurityNeeded

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getParent

Constructor Detail

OdiFlexField

public OdiFlexField(java.lang.Class pFlexFieldUserClass,
                    java.lang.String pCode)

Create a new OdiFlexField.

Parameters:

pFlexFieldUserClass - a class implementing IFlexFieldUser interface

pCode - code of the flex field

Method Detail

setName

public void setName(java.lang.String pName)

Defines the name of this OdiFlexField.

Parameters:

pName - the name

See Also:

getName()

getName

public java.lang.String getName()

Obtains this OdiFlexField's name.

Specified by:

getName in interface IOdiEntity

Overrides:

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

Returns:

the name

See Also:

setName(String)

getCode

public java.lang.String getCode()

Obtains this OdiFlexField's code.

Returns:

the code

getFlexFieldType

public OdiFlexField.FlexFieldType getFlexFieldType()

Obtains the type of this OdiFlexField.

Returns:

the type as a OdiFlexField.FlexFieldType

See Also:

setFlexFieldType(FlexFieldType)

setFlexFieldType

public void setFlexFieldType(OdiFlexField.FlexFieldType pFlexFieldType)

Defines the type of this OdiFlexField.

Parameters:

pFlexFieldType - the type of flex field

See Also:

getFlexFieldType()

getFlexFieldId

public java.lang.Number getFlexFieldId()

This OdiFlexField ID.

Returns:

the ID

getFlexFieldUserClass

public java.lang.Class getFlexFieldUserClass()

Get the implementation of IFlexFieldUser for which this FlexField is relevant.

Returns:

a class implementing IFlexFieldUser

getTechnology

public OdiTechnology getTechnology()

Get the technology this FlexField applies, or null if this FlexField applies to all technologies or is not technology related.

Returns:

an instance of OdiTechnology

See Also:

setTechnology(OdiTechnology)

setTechnology

public void setTechnology(OdiTechnology pTechnology)

The technology to which this FlexField applies. null means that this flexfields applies to all technologies or is not technology related.

Parameters:

pTechnology - the technology, or null

See Also:

getTechnology()

getOrder

public int getOrder()

Obtains this OdiFlexField's order.

Returns:

the order

See Also:

setOrder(int)

setOrder

public void setOrder(int pOrder)

Defines this OdiFlexField's order.

Parameters:

pOrder - the order

See Also:

getOrder()

setDefaultValue

public void setDefaultValue(java.lang.Object pDefaultValue)

Defines the default value for this OdiFlexField.

Parameters:

pDefaultValue - the default value

See Also:

getDefaultValue()

getDefaultValue

public java.lang.Object getDefaultValue()

Obtains the default value.

Returns:

default value

See Also:

setDefaultValue(Object)

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