oracle.odi.domain.runtime.session

Class OdiSessionCustomVariable

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.runtime.common.AbstractRuntimeVariable

oracle.odi.domain.runtime.session.OdiSessionCustomVariable

All Implemented Interfaces:

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

public class OdiSessionCustomVariable
extends AbstractRuntimeVariable

OdiSessionCustomVariable represents the variable which is related to only one specific OdiSession. This can be a variable overriding the default value of original OdiSessionBlueprintVariable. In this case OdiSessionCustomVariable holds reference to OdiSessionBlueprintVariable, which properties are overridden. The only Variable's property available for modification is Default Value. It may be useful to modify this property for debugging/fixing the execution.

To override Default Value of OdiSessionBlueprintVariable, new instance of OdiSessionCustomVariable should be created in runtime repository. Runtime Agent will take its Default Value, instead of using initial value from blueprint then.

OdiSessionCustomVariable can be created by user after OdiSession executed once at least. It is possible to modify this object during its life-cycle. It remains in repository until the related OdiSession is removed.

User then can obtain all OdiSessionCustomVariables of OdiSession using OdiSession.getSessionCustomVariables() method.

Since:

12.1

See Also:

OdiSessionBlueprintVariable, OdiSession.getSessionCustomVariables(), OdiSession.addSessionCustomVariable(OdiSessionCustomVariable), Serialized Form

Constructor Summary

Constructors

Constructor and Description
OdiSessionCustomVariable(OdiSessionBlueprintVariable pSessionBlueprintVariable) Constructs new OdiSessionCustomVariable overriding the specified OdiSessionBlueprintVariable.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getDefaultValue() Returns the default value of variable.
java.lang.String	getDescription() Returns the description of underlying OdiSessionBlueprintVariable.
java.io.Serializable	getInternalId() Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.
IRepositoryEntity	getSecurityContainer() Define a generic way to retrieve container for entities.
OdiSessionBlueprintVariable	getSessionBlueprintVariable() Returns the OdiSessionBlueprintVariable, which default value is overridden in this OdiSessionCustomVariable.
java.lang.Number	getSessionId() Returns the ID of OdiSession.
VariableType	getType() Returns the type of underlying OdiSessionBlueprintVariable.
ValuePersistence	getValuePersistence() Returns the value persistence type of underlying OdiSessionBlueprintVariable.
java.lang.Number	getVariableOrder() Returns the variable order of underlying OdiSessionBlueprintVariable.
boolean	isReadOnly() Returns true if the underlying OdiSessionBlueprintVariable is not a startup parameter, false - otherwise.
void	setDefaultValue(java.lang.Object pValue) Specifies the default value for variable.

Methods inherited from class oracle.odi.domain.runtime.common.AbstractRuntimeVariable

getName

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

equals, getGlobalId, getNumericId, hasCustomizedPersistenceMethodFor, hashCode, invokeCustomizedPersistenceMethodFor, toString

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

clone

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OdiSessionCustomVariable

public OdiSessionCustomVariable(OdiSessionBlueprintVariable pSessionBlueprintVariable)

Constructs new OdiSessionCustomVariable overriding the specified OdiSessionBlueprintVariable. This will inform the Runtime Agent that variable's default value was overridden between OdiSession restarts.

The constructed overriding variable should be added to OdiSession.

Parameters:

pSessionBlueprintVariable - an OdiSessionBlueprintVariable

See Also:

OdiSession.addSessionCustomVariable(OdiSessionCustomVariable)

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.

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

getSessionId

public java.lang.Number getSessionId()

Returns the ID of OdiSession.

Returns:

session ID

getSessionBlueprintVariable

public OdiSessionBlueprintVariable getSessionBlueprintVariable()

Returns the OdiSessionBlueprintVariable, which default value is overridden in this OdiSessionCustomVariable.

Returns:

OdiSessionBlueprintVariable

getDefaultValue

public java.lang.Object getDefaultValue()

Returns the default value of variable.

Overrides:

getDefaultValue in class AbstractRuntimeVariable

Returns:

default value

See Also:

AbstractRuntimeVariable.getDefaultValue(), setDefaultValue(Object)

setDefaultValue

public void setDefaultValue(java.lang.Object pValue)

Specifies the default value for variable.

Parameters:

pValue - default value

See Also:

getDefaultValue()

getType

public VariableType getType()

Returns the type of underlying OdiSessionBlueprintVariable.

Overrides:

getType in class AbstractRuntimeVariable

Returns:

the type

isReadOnly

public boolean isReadOnly()

Returns true if the underlying OdiSessionBlueprintVariable is not a startup parameter, false - otherwise.

Overrides:

isReadOnly in class AbstractRuntimeVariable

Returns:

whether the variable is read only

getValuePersistence

public ValuePersistence getValuePersistence()

Returns the value persistence type of underlying OdiSessionBlueprintVariable.

Overrides:

getValuePersistence in class AbstractRuntimeVariable

Returns:

the value persistence type

getDescription

public java.lang.String getDescription()

Returns the description of underlying OdiSessionBlueprintVariable.

Overrides:

getDescription in class AbstractRuntimeVariable

Returns:

the description

getVariableOrder

public java.lang.Number getVariableOrder()

Returns the variable order of underlying OdiSessionBlueprintVariable.

Overrides:

getVariableOrder in class AbstractRuntimeVariable

Returns:

the variable order