Skip navigation links

oracle.odi.domain.runtime.scenario
Class OdiScenarioVariable

java.lang.Object
oracle.odi.domain.support.BusinessObject
oracle.odi.domain.support.AbstractRepositoryEntity
oracle.odi.domain.runtime.scenario.OdiScenarioVariable

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IRepositoryEntity

public final class OdiScenarioVariable

extends oracle.odi.domain.support.AbstractRepositoryEntity

Defines a variable inside an OdiScenario and is part of the OdiScenario - OdiScenarioVariable - OdiScenarioSequence - OdiScenarioReport aggregate.

An OdiScenarioVariable is created during scenario generation for each ODI Variable referenced inside source component of the scenario. Once created, an OdiScenarioVariable is by default readOnly, meaning it cannot be overriden by a startup parameter when a scenario is executed. However, this property can be set to false to make it overridable. An OdiScenarioVariable cannot be removed from the OdiScenario it belongs and its life cycle ends only when enclosing OdiScenario is removed from runtime repository.

Since:

11.1.1.3.0

See Also:

Serialized Form

Method Summary

Action	getAction() Returns Action of this variable (see enum Action).
java.lang.Object	getDefaultValue() Obtain the default value of this variable.
java.lang.String	getDescription() Obtains the description of this OdiScenarioVariable.
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() Return the name of this variable.
IRepositoryEntity	getSecurityContainer() Define a generic way to retrieve container for entities.
VariableType	getType() Return the type of this variable entity.
java.lang.Number	getVariableOrder() Returns the order of this OdiScenarioVariable.
boolean	isReadOnly() Return whether this variable is read-only or not.
void	setReadOnly(boolean pReadOnly)

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

clone

Methods inherited from class java.lang.Object

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

Method Detail

isReadOnly

public boolean isReadOnly()

Return whether this variable is read-only or not.

If read-only, this variable's value cannot be changed, and associated scenario will be executed with its default value. Otherwise, this variable value can be changed at runtime when executing an OdiScenario.

Returns:

whether this variable is read-only or not

setReadOnly

public void setReadOnly(boolean pReadOnly)

getType

public VariableType getType()

Return the type of this variable entity.

Returns:

the type of this variable entity

getName

public java.lang.String getName()

Return the name of this variable.

Returns:

the name of this variable

getDefaultValue

public java.lang.Object getDefaultValue()

Obtain the default value of this variable.

When calling that method, the value can be casted into relevant class according this variable's VariableType.

Returns:

the default value of this variable

getAction

public Action getAction()

Returns Action of this variable (see enum Action).

Returns:

Action of this variable (see enum Action)

getDescription

public java.lang.String getDescription()

Obtains the description of this OdiScenarioVariable.

Returns:

this scenario's description

getVariableOrder

public java.lang.Number getVariableOrder()

Returns the order of this OdiScenarioVariable.

Returns:

the order of this OdiScenarioVariable

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.

Returns:

the persistence identity of this instance

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

Description copied from interface: IRepositoryEntity

Define a generic way to retrieve container for entities.

Returns:

container entity

Skip navigation links