oracle.odi.domain.runtime.session
Class OdiSessionVariable

java.lang.Object
  oracle.odi.domain.support.BusinessObject
      oracle.odi.domain.support.AbstractRepositoryEntity
          oracle.odi.domain.runtime.session.OdiSessionVariable

All Implemented Interfaces:

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

public class OdiSessionVariable
extends oracle.odi.domain.support.AbstractRepositoryEntity

Defines a variable inside an OdiSession and is part of the OdiSession - OdiSessionVariable - OdiSessionStepLog aggregate.

An OdiSessionVariable is created during session creation process. It contains the default value the session will use during its execution. However, this variable default value may be overridden with a startup parameter. It will be destroyed when the session it belongs is removed from runtime repository.

Since:

11.1.1.3.0

See Also:

Serialized Form

Method Summary

Action	getAction() Returns Action of this variable.
java.lang.Object	getDefaultValue() Gets the default value of this variable.
java.lang.String	getDescription() Gets the description of this variable.
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() Gets the name of this variable.
IRepositoryEntity	getSecurityContainer() Define a generic way to retrieve container for entities.
int	getSessionId() Returns the ID of session associated with this OdiSessionVariable.
VariableType	getType() Gets the type of this variable.

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

getAction

public Action getAction()

Returns Action of this variable.

Returns:

Action of this variable

getDefaultValue

public java.lang.Object getDefaultValue()

Gets the default value of this variable.

Returns:

the default value of this variable

getDescription

public java.lang.String getDescription()

Gets the description of this variable.

Returns:

the description of this variable

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

getName

public java.lang.String getName()

Gets the name of this variable.

Returns:

the name of this variable

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

Description copied from interface: IRepositoryEntity

Define a generic way to retrieve container for entities.

Returns:

container entity

getSessionId

public int getSessionId()

Returns the ID of session associated with this OdiSessionVariable.

Returns:

the session ID

getType

public VariableType getType()

Gets the type of this variable.

Returns:

the type of this variable