oracle.odi.domain.model

Class OdiCondition

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.support.AbstractOdiEntity

oracle.odi.domain.model.OdiCondition

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IFlexFieldUser, IModelObject, ICondition, IOdiEntity, IRepositoryEntity, IWorkDevelopmentOdiEntity

public class OdiCondition
extends oracle.odi.domain.support.AbstractOdiEntity
implements IWorkDevelopmentOdiEntity, IFlexFieldUser, ICondition

An OdiCondition allows to define a data constraint to check on an OdiDataStore.

ODI manages two types of OdiCondition. Supported type of condition is defined by the enum OdiCondition.ConditionType. An OdiCondition's type can be changed using setConditionType(ConditionType).

Since:

11.1.1.3.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OdiCondition.ConditionType Defines the type of an OdiCondition.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NAME_MAX_LENGTH Maximum length supported for the "name" property.

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

STARTING_INTERNAL_VERSION

Constructor Summary

Constructors

Constructor and Description
OdiCondition(OdiDataStore pDataStore, java.lang.String pName) Creates a condition belonging to pDatastore with the name pName.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Number	getConditionId() Returns the internal identifier of this OdiCondition instance.
OdiCondition.ConditionType	getConditionType() Returns the OdiCondition.ConditionType of this OdiCondition instance.
OdiDataStore	getDataStore() Obtains the OdiDataStore to which this condition belongs.
java.lang.String	getDomainInterfaceType()
java.util.Collection	getFlexFieldsValues() * Obtains flex fields values related to this IFlexFieldUser.
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	getMessage() Returns the message used when the condition is not respected.
java.lang.String	getName() Returns the name of this OdiCondition instance.
java.lang.String	getQualifiedName()
IRepositoryEntity	getSecurityContainer() Define a generic way to retrieve container for entities.
Expression	getWhereClause() Returns the Expression representing the where clause defined on this OdiCondition.
java.lang.String	getWhereClauseString() Returns the expression text representing the where clause defined on this condition.
void	initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder) Initialize flex fields related to this IFlexFieldUser.
boolean	isActive() Returns whether this OdiCondition instance is active or not.
boolean	isDBCondition() Returns whether condition is defined in the database.
boolean	isFlowCheckEnabled() Returns whether flow check is enabled on this OdiCondition instance or not.
boolean	isInDatabase() Returns whether this OdiCondition exists in database or not.
boolean	isODICondition() Returns whether condition is custom-defined in ODI.
boolean	isStaticCheckEnabled() Returns whether static check is enabled on this OdiCondition instance or not.
void	setActive(boolean pActive) Define whether this OdiCondition is active or not.
void	setConditionType(OdiCondition.ConditionType pConditionType) Sets the OdiCondition.ConditionType of this OdiCondition instance.
void	setFlowCheckEnabled(boolean pFlowCheckEnabled) Defines whether flow check is enabled on this OdiCondition instance or not.
void	setInDatabase(boolean pInDatabase) Defines whether this OdiCondition exists in database or not.
void	setMessage(java.lang.String pMessage) Defines the message used when the condition is not respected.
void	setStaticCheckEnabled(boolean pStaticCheckEnabled) Defines whether static check is enabled on this OdiCondition instance or not.
void	setWhereClause(Expression pClause) Sets the where clause for this OdiCondition.

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

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

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

getGlobalId, getNumericId, hasCustomizedPersistenceMethodFor, invokeCustomizedPersistenceMethodFor

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

Methods inherited from interface oracle.odi.domain.adapter.IModelObject

getGlobalId, getNumericId

Field Detail

NAME_MAX_LENGTH

public static final int NAME_MAX_LENGTH

Maximum length supported for the "name" property.

See Also:

setName(String), Constant Field Values

Constructor Detail

OdiCondition

public OdiCondition(OdiDataStore pDataStore,
            java.lang.String pName)

Creates a condition belonging to pDatastore with the name pName.

Parameters:

pDataStore - parent datastore

pName - name of this condition

Throws:

DomainRuntimeException - if the Datastore is null or if the name is null, empty or longer than 128

Method Detail

isActive

public boolean isActive()

Returns whether this OdiCondition instance is active or not.

Returns:

true if this condition is active, false otherwise

See Also:

setActive(boolean)

setActive

public void setActive(boolean pActive)

Define whether this OdiCondition is active or not.

By default, an OdiCondition is active (i.e. true).

Parameters:

pActive - true to make this condition active, false otherwise.

See Also:

isActive()

getConditionType

public OdiCondition.ConditionType getConditionType()

Returns the OdiCondition.ConditionType of this OdiCondition instance.

Returns:

the condition type.

See Also:

OdiCondition.ConditionType, setConditionType(ConditionType)

setConditionType

public void setConditionType(OdiCondition.ConditionType pConditionType)

Sets the OdiCondition.ConditionType of this OdiCondition instance.

By default an OdiConditin's type is OdiCondition.ConditionType.ODI_CONDITION.

Parameters:

pConditionType - the type of condition

See Also:

getConditionType()

isFlowCheckEnabled

public boolean isFlowCheckEnabled()

Returns whether flow check is enabled on this OdiCondition instance or not.

Specified by:

isFlowCheckEnabled in interface ICondition

Returns:

true if enabled, false otherwise.

See Also:

setFlowCheckEnabled(boolean)

setFlowCheckEnabled

public void setFlowCheckEnabled(boolean pFlowCheckEnabled)

Defines whether flow check is enabled on this OdiCondition instance or not.

By default flow check is enabled.

Parameters:

pFlowCheckEnabled - true to enable flow check, false otherwise

See Also:

isFlowCheckEnabled()

isInDatabase

public boolean isInDatabase()

Returns whether this OdiCondition exists in database or not.

Returns:

true if it exists in database, false otherwise

See Also:

setInDatabase(boolean)

setInDatabase

public void setInDatabase(boolean pInDatabase)

Defines whether this OdiCondition exists in database or not.

By default an OdiCondition is marked as not defined in database (i.e. this property is false).

Parameters:

pInDatabase - true to mark this condition as defined in db, false otherwise

See Also:

isInDatabase()

getMessage

public java.lang.String getMessage()

Returns the message used when the condition is not respected.

Returns:

the message of this condition.

See Also:

setMessage(String)

setMessage

public void setMessage(java.lang.String pMessage)

Defines the message used when the condition is not respected.

This message will be used as error message.

Parameters:

pMessage - the error message

See Also:

getMessage()

isStaticCheckEnabled

public boolean isStaticCheckEnabled()

Returns whether static check is enabled on this OdiCondition instance or not.

Specified by:

isStaticCheckEnabled in interface ICondition

Returns:

true if enable, false otherwise

See Also:

setStaticCheckEnabled(boolean)

setStaticCheckEnabled

public void setStaticCheckEnabled(boolean pStaticCheckEnabled)

Defines whether static check is enabled on this OdiCondition instance or not.

By default, static check is enabled.

Parameters:

pStaticCheckEnabled - true to enable static check, false otherwise

See Also:

isStaticCheckEnabled()

getConditionId

public java.lang.Number getConditionId()

Returns the internal identifier of this OdiCondition instance.

Returns:

the condition Id.

getName

public java.lang.String getName()

Returns the name of this OdiCondition instance.

Specified by:

getName in interface IFlexFieldUser

Specified by:

getName in interface IModelObject

Specified by:

getName in interface ICondition

Specified by:

getName in interface IOdiEntity

Overrides:

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

Returns:

the name

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

getDataStore

public OdiDataStore getDataStore()

Obtains the OdiDataStore to which this condition belongs.

Specified by:

getDataStore in interface ICondition

Returns:

the parent OdiDataStore

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

getWhereClause

public Expression getWhereClause()

Returns the Expression representing the where clause defined on this OdiCondition.

Returns:

the where clause expression.

See Also:

setWhereClause(Expression)

getWhereClauseString

public java.lang.String getWhereClauseString()

Description copied from interface: ICondition

Returns the expression text representing the where clause defined on this condition.

Specified by:

getWhereClauseString in interface ICondition

Returns:

the where clause text

setWhereClause

public void setWhereClause(Expression pClause)

Sets the where clause for this OdiCondition.

Parameters:

pClause - the where clause

See Also:

getWhereClause()

getFlexFieldsValues

public java.util.Collection getFlexFieldsValues()

* Obtains flex fields values related to this IFlexFieldUser. In most implementations method initFlexFields(IOdiFlexFieldFinder) should be called before calling this method.

Specified by:

getFlexFieldsValues in interface IFlexFieldUser

Returns:

an unmodifiable Collection of flex field values

Since:

11.1.1.5.0

initFlexFields

public void initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder)

Description copied from interface: IFlexFieldUser

Initialize flex fields related to this IFlexFieldUser.

Specified by:

initFlexFields in interface IFlexFieldUser

Parameters:

pOdiFlexFieldFinder - OdiFlexField finder to be used to query flex fields

Since:

11.1.1.5.0

isDBCondition

public boolean isDBCondition()

Description copied from interface: ICondition

Returns whether condition is defined in the database. ODI will let the database check this condition.

Specified by:

isDBCondition in interface ICondition

Returns:

true if defined in database, false otherwise

isODICondition

public boolean isODICondition()

Description copied from interface: ICondition

Returns whether condition is custom-defined in ODI. ODI will internally check this condition.

Specified by:

isODICondition in interface ICondition

Returns:

true if custom-defined, false otherwise

getDomainInterfaceType

public java.lang.String getDomainInterfaceType()

Specified by:

getDomainInterfaceType in interface IModelObject

Returns:

full class name

getQualifiedName

public java.lang.String getQualifiedName()

Specified by:

getQualifiedName in interface IModelObject

Returns:

fully qualified name of this object.