|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.5.0) E17060-02 |
|||||||||
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.model.OdiCondition
public class OdiCondition
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)
.
Nested Class Summary | |
---|---|
static class |
OdiCondition.ConditionType Defines the type of an OdiCondition. |
Field Summary | |
---|---|
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 | |
---|---|
OdiCondition(OdiDataStore pDataStore, java.lang.String pName) Creates a condition belonging to pDatastore with the name pName. |
Method Summary | |
---|---|
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.util.Collection<IFlexFieldValue> |
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. |
IRepositoryEntity |
getSecurityContainer() Define a generic way to retrieve container for entities. |
Expression |
getWhereClause() Returns the Expression representing the where clause defined on this OdiCondition . |
void |
initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder) Initialize flex fields related to this IFlexFieldUser . |
boolean |
isActive() Returns whether this OdiCondition instance is active or not. |
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 |
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, 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, isInstanceLevelSecurityNeeded |
Field Detail |
---|
public static final int NAME_MAX_LENGTH
setName(String)
, Constant Field ValuesConstructor Detail |
---|
public OdiCondition(OdiDataStore pDataStore, java.lang.String pName)
pDataStore
- parent datastorepName
- name of this conditionjava.lang.IllegalArgumentException
- if the Datastore is null or if the name is null, empty or longer than 128Method Detail |
---|
public boolean isActive()
OdiCondition
instance is active or not.true
if this condition is active, false
otherwisesetActive(boolean)
public void setActive(boolean pActive)
OdiCondition
is active or not.
By default, an OdiCondition is active (i.e. true
).
pActive
- true
to make this condition active, false
otherwise.isActive()
public OdiCondition.ConditionType getConditionType()
OdiCondition.ConditionType
of this OdiCondition
instance.OdiCondition.ConditionType
, setConditionType(ConditionType)
public void setConditionType(OdiCondition.ConditionType pConditionType)
OdiCondition.ConditionType
of this OdiCondition
instance.
By default an OdiConditin's type is OdiCondition.ConditionType.ODI_CONDITION
.
pConditionType
- the type of conditiongetConditionType()
public boolean isFlowCheckEnabled()
OdiCondition
instance or not.true
if enabled, false
otherwise.setFlowCheckEnabled(boolean)
public void setFlowCheckEnabled(boolean pFlowCheckEnabled)
OdiCondition
instance or not.
By default flow check is enabled.
pFlowCheckEnabled
- true
to enable flow check, false
otherwiseisFlowCheckEnabled()
public boolean isInDatabase()
OdiCondition
exists in database or not.true
if it exists in database, false
otherwisesetInDatabase(boolean)
public void setInDatabase(boolean pInDatabase)
OdiCondition
exists in database or not.
By default an OdiCondition is marked as not defined in database (i.e. this property is false
).
pInDatabase
- true
to mark this condition as defined in db, false
otherwiseisInDatabase()
public java.lang.String getMessage()
setMessage(String)
public void setMessage(java.lang.String pMessage)
This message will be used as error message.
pMessage
- the error messagegetMessage()
public boolean isStaticCheckEnabled()
OdiCondition
instance or not.true
if enable, false
otherwisesetStaticCheckEnabled(boolean)
public void setStaticCheckEnabled(boolean pStaticCheckEnabled)
OdiCondition
instance or not.
By default, static check is enabled.
pStaticCheckEnabled
- true
to enable static check, false
otherwiseisStaticCheckEnabled()
public java.lang.Number getConditionId()
OdiCondition
instance.public java.lang.String getName()
OdiCondition
instance.getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public OdiDataStore getDataStore()
OdiDataStore
to which this condition belongs.OdiDataStore
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 Expression getWhereClause()
Expression
representing the where clause defined on this OdiCondition
.setWhereClause(Expression)
public void setWhereClause(Expression pClause)
OdiCondition
.pClause
- the where clausegetWhereClause()
public java.util.Collection<IFlexFieldValue> getFlexFieldsValues()
IFlexFieldUser
IFlexFieldUser
.getFlexFieldsValues
in interface IFlexFieldUser
public void initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder)
IFlexFieldUser
IFlexFieldUser
.initFlexFields
in interface IFlexFieldUser
pOdiFlexFieldFinder
- OdiFlexField
finder to be used to query flex fields
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.5.0) E17060-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |