oracle.odi.domain.runtime.loadplan

Class OdiLoadPlanStepCase

java.lang.Object

AbstractRepositoryEntity

oracle.odi.domain.runtime.loadplan.OdiLoadPlanElement

oracle.odi.domain.runtime.loadplan.OdiLoadPlanStep

oracle.odi.domain.runtime.loadplan.OdiLoadPlanStepCase

public class OdiLoadPlanStepCase
extends OdiLoadPlanStep

An OdiLoadPlanStepCase is one of the OdiLoadPlanStepCase.
It represents an aggregate "case-when*-else" (* there can be multiple when clauses).

The life cycle of OdiLoadPlanStepCase is managed by the aggregate OdiLoadPlan.
It begins when a user adds an OdiLoadPlanStepCase to the OdiLoadPlan. It is then typically stored inside ODI runtime repository when the OdiLoadPlan is persisted.
The users can modify the OdiLoadPlanStepCase in order to make it fit their needs.
The life cycle ends when a user removes the OdiLoadPlanStepCase from the OdiLoadPlan.

Since:

11.1.1.5.0

Nested Class Summary

Nested classes/interfaces inherited from class oracle.odi.domain.runtime.loadplan.OdiLoadPlanStep

OdiLoadPlanStep.ExceptionBehavior, OdiLoadPlanStep.RegenerationMode

Field Summary

Fields inherited from class oracle.odi.domain.runtime.loadplan.OdiLoadPlanStep

MAX_PRIORITY, MIN_PRIORITY, SESSION_KEYWORDS_MAX_LENGTH

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

NAME_MAX_LENGTH

Method Summary

Modifier and Type	Method and Description
OdiCaseWhen	addCaseWhen(OdiCaseWhen.ComparisonOperator pComparisonOperator, java.lang.Object pValue) Creates an OdiCaseWhen, adds it to the list and return it
OdiLoadPlanStepCase	copy(boolean generateName) Deprecated. since 11.1.1.7.0 consider using OdiLoadPlanStep.duplicate() or OdiLoadPlanStep.duplicate(OdiLoadPlanStep) method.
OdiCaseElse	getCaseElse()
java.util.List	getCaseWhenList()
OdiLoadPlanVariable	getTestVariable()
void	moveCaseWhenAfter(OdiCaseWhen pCaseToMove, OdiCaseWhen pAfterThisCase) Moves the given step in the children list, putting it right after the second parameter step. No action if pStepToMove is already right after pAfterThisStep.
void	moveCaseWhenBefore(OdiCaseWhen pCaseToMove, OdiCaseWhen pBeforeThisCase) Moves the given step in the children list, putting it right before the second parameter step. No action if pStepToMove is already right after pBeforeThisStep.
void	removeCaseElse() remove the current CaseElse of the OdiLoadPlanStepCase.
void	removeCaseWhen(OdiCaseWhen pOdiCaseWhen) Removes the given OdiCaseWhen of the list of OdiCaseWhen available for this OdiLoadPlanStepCase.
void	setCaseElse(java.lang.String pName) Initializes the OdiCaseElse of this OdiLoadPlanStepCase if the current caseElse is not null, this method should throw an exception
void	setTestVariable(OdiLoadPlanVariable testVariable)

Methods inherited from class oracle.odi.domain.runtime.loadplan.OdiLoadPlanStep

addVariable, addVariable, duplicate, duplicate, getException, getExceptionBehavior, getInternalId, getLoadPlanStepVariables, getOrder, getParentElement, getSessionKeywordsAsString, getTimeout, isEnabled, regenerate, removeVariable, setEnabled, setException, setExceptionBehavior, setSessionKeywordsAsString, setTimeout

Methods inherited from class oracle.odi.domain.runtime.loadplan.OdiLoadPlanElement

getLoadPlan, getName, getSecurityContainer, getStepId, hasDisabledParent, setName, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

addCaseWhen

public OdiCaseWhen addCaseWhen(OdiCaseWhen.ComparisonOperator pComparisonOperator,
                               java.lang.Object pValue)

Creates an OdiCaseWhen, adds it to the list and return it

Parameters:

pComparisonOperator - the OdiCaseWhen.ComparisonOperator used to test the OdiLoadPlanVariable. It must not be null.

pValue - the value to use for the test of the OdiLoadPlanVariable. It must not be null.

Returns:

the OdiCaseWhen created

See Also:

removeCaseWhen(OdiCaseWhen), #getCaseWhenLst(), OdiCaseWhen

removeCaseWhen

public void removeCaseWhen(OdiCaseWhen pOdiCaseWhen)

Removes the given OdiCaseWhen of the list of OdiCaseWhen available for this OdiLoadPlanStepCase.

Parameters:

pOdiCaseWhen - the OdiCaseWhen to remove from the list of when clauses defined for this OdiLoadPlanStepCase. It must not be null

See Also:

#addCaseWhen(oracle.odi.domain.runtime.loadplan.OdiCaseWhen.ComparisonOperator, Number), #getCaseWhenLst(), OdiCaseWhen

getCaseWhenList

public java.util.List getCaseWhenList()

Returns:

the unmodifiable list of when clauses defined for this OdiLoadPlanStepCase

See Also:

#addCaseWhen(oracle.odi.domain.runtime.loadplan.OdiCaseWhen.ComparisonOperator, Number), removeCaseWhen(OdiCaseWhen), OdiCaseWhen

getCaseElse

public OdiCaseElse getCaseElse()

Returns:

the ELSE clause defined for this OdiLoadPlanStepCase.

See Also:

OdiCaseElse

setCaseElse

public void setCaseElse(java.lang.String pName)

Initializes the OdiCaseElse of this OdiLoadPlanStepCase if the current caseElse is not null, this method should throw an exception

Parameters:

pName - must not be null, empty or longer than #NAME_MAX_LENGTH

Throws:

DomainRuntimeException - if the name is null, empty or longer than #NAME_MAX_LENGTH.

java.lang.UnsupportedOperationException - if the caseElse is already defined for this StepCase.

See Also:

OdiCaseElse

removeCaseElse

public void removeCaseElse()

remove the current CaseElse of the OdiLoadPlanStepCase. Throw an exception if there's no current OdiCaseElse

getTestVariable

public OdiLoadPlanVariable getTestVariable()

Returns:

the OdiLoadPlanVariable associated to this OdiLoadPlanStepCase

See Also:

OdiLoadPlanVariable, setTestVariable(OdiLoadPlanVariable)

setTestVariable

public void setTestVariable(OdiLoadPlanVariable testVariable)

Parameters:

testVariable - the OdiLoadPlanVariable associated to this OdiLoadPlanStepCase. Must not be null or defined in another load plan.

Throws:

DomainRuntimeException - if the variable is null or defined in another load plan

See Also:

getTestVariable(), OdiLoadPlanVariable

moveCaseWhenAfter

public void moveCaseWhenAfter(OdiCaseWhen pCaseToMove,
                              OdiCaseWhen pAfterThisCase)

Moves the given step in the children list, putting it right after the second parameter step.
No action if pStepToMove is already right after pAfterThisStep.

Parameters:

pCaseToMove -

pAfterThisCase -

Throws:

DomainRuntimeException - if the steps are not defined in the same step container

moveCaseWhenBefore

public void moveCaseWhenBefore(OdiCaseWhen pCaseToMove,
                               OdiCaseWhen pBeforeThisCase)

Moves the given step in the children list, putting it right before the second parameter step.
No action if pStepToMove is already right after pBeforeThisStep.

Parameters:

pCaseToMove -

pBeforeThisCase -

Throws:

DomainRuntimeException - if the steps are not defined in the same step container

copy

public OdiLoadPlanStepCase copy(boolean generateName)

Deprecated. since 11.1.1.7.0 consider using OdiLoadPlanStep.duplicate() or OdiLoadPlanStep.duplicate(OdiLoadPlanStep) method.

FOR INTERNAL USE ONLY

Overrides:

copy in class OdiLoadPlanStep