Skip navigation links

Oracle® Data Integrator Java API Reference
11g Release 1 (11.1.1.6.0)

E17060-03


oracle.odi.domain.runtime.loadplan
Class OdiCaseWhen

java.lang.Object
  extended by oracle.odi.domain.support.BusinessObject
      extended by oracle.odi.domain.support.AbstractRepositoryEntity
          extended by oracle.odi.domain.runtime.loadplan.OdiLoadPlanElement
              extended by oracle.odi.domain.runtime.loadplan.OdiLoadPlanCaseCondition
                  extended by oracle.odi.domain.runtime.loadplan.OdiCaseWhen

All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, IRepositoryEntity

public class OdiCaseWhen
extends OdiLoadPlanCaseCondition

This class represents the 'when' clause in a "case-when-else" step of an OdiLoadPlan.

It's part of an aggregate managed by OdiLoadPlanStepCase. Its life cycle is managed by the OdiLoadPlanStepCase class, which in turn is managed by the OdiLoadPlan class.

An OdiCaseWhen life cycle begins when the user has created a OdiLoadPlanStepCase in an OdiLoadPlan and starts adding When clauses.
It's then typically stored in the runtime repository when the OdiLoadPlan is persisted.
The users can modify the OdiCaseWhen to fit their needs.
The life cycle ends when the OdiCaseWhen is removed from the OdiLoadPlanStepCase.

The OdiCaseWhen defines an comparison on the variable chosen in the OdiLoadPlanStepCase and a root OdiLoadPlanStep that will describe the action to execute if the comparison is true.
By Default the root step is serial.

Order is managed at creation time. When moving, order is managed by the step container. Order is then managed when removing a child.

Since:
11.1.1.5.0
See Also:
OdiLoadPlan, OdiLoadPlanStepCase, Serialized Form

Nested Class Summary
static class OdiCaseWhen.ComparisonOperator
          Comparisons possible for the OdiLoadPlanVariable defined on the parent OdiLoadPlanStepCase.

 

Field Summary

 

Fields inherited from class oracle.odi.domain.runtime.loadplan.OdiLoadPlanElement
NAME_MAX_LENGTH

 

Method Summary
 java.io.Serializable getInternalId()
          Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.
 int getOrder()
           
 OdiCaseWhen.ComparisonOperator getTestOperator()
           
 java.lang.Object getValue()
           
 void setOrder(int order)
           
 void setTestOperator(OdiCaseWhen.ComparisonOperator testOperator)
           
 void setValue(java.lang.Object pValue)
           

 

Methods inherited from class oracle.odi.domain.runtime.loadplan.OdiLoadPlanCaseCondition
copy, duplicate, duplicate, getParentElement, getRootStep, isEnabled, setEnabled

 

Methods inherited from class oracle.odi.domain.runtime.loadplan.OdiLoadPlanElement
getName, getSecurityContainer, getStepId, hasDisabledParent, setName, toString

 

Methods inherited from class oracle.odi.domain.support.BusinessObject
clone

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Method Detail

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
Overrides:
getInternalId in class OdiLoadPlanCaseCondition
Returns:
the persistence identity of this instance

getTestOperator

public OdiCaseWhen.ComparisonOperator getTestOperator()
Returns:
Operator used for the test on the OdiLoadPlanVariable defined in the parent OdiLoadPlanStepCase.
See Also:
OdiCaseWhen.ComparisonOperator, setTestOperator(ComparisonOperator)

setTestOperator

public void setTestOperator(OdiCaseWhen.ComparisonOperator testOperator)
Parameters:
testOperator - Operator used for the test on the OdiLoadPlanVariable defined in the parent OdiLoadPlanStepCase. Must not be null.
Throws:
DomainRuntimeException - if the testOperator is null
See Also:
OdiCaseWhen.ComparisonOperator, getTestOperator()

getValue

public java.lang.Object getValue()
Returns:
Value against which the OdiLoadPlanStepCase variable is tested
See Also:
setValue(Object)

setValue

public void setValue(java.lang.Object pValue)
Parameters:
value - Value against which the OdiLoadPlanStepCase variable is tested. Must not be null
See Also:
getValue()

setOrder

public void setOrder(int order)
Parameters:
Defines - the order of this case when in the OdiLoadPlanStepCase.
See Also:
getOrder(), OdiLoadPlanStepSerial

getOrder

public int getOrder()
Returns:
Defines the order of this case when in the OdiLoadPlanStepCase.
See Also:
setOrder(int), OdiLoadPlanStepCase

Skip navigation links

Oracle® Data Integrator Java API Reference
11g Release 1 (11.1.1.6.0)

E17060-03


Copyright © 2011, Oracle and/or its affiliates. All rights reserved.