oracle.odi.domain.runtime.scenario

Class OdiScenario

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.support.AbstractOdiEntity

oracle.odi.domain.runtime.scenario.OdiScenario

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, oracle.odi.core.audit.support.IAuditableFirstClassObject, IFlexFieldUser, IModelObject, IModelObjectBase, IScenario, oracle.odi.domain.impexp.IExportable, IOdiEntity, IRepositoryEntity, IWorkRuntimeOdiEntity, IExecutable, oracle.odi.impexp.smartie.ISmartExportable

public final class OdiScenario
extends oracle.odi.domain.support.AbstractOdiEntity
implements IWorkRuntimeOdiEntity, oracle.odi.domain.impexp.IExportable, IFlexFieldUser, oracle.odi.impexp.smartie.ISmartExportable, IScenario, IExecutable, oracle.odi.core.audit.support.IAuditableFirstClassObject

An ODI Scenario is designed to put a source component (interface, package, procedure, variable) into production. It results from the generation of code (SQL, shell, etc) for this component.

OdiScenario is the root entity in OdiScenario - OdiScenarioVariable - OdiScenarioSequence - OdiScenarioReport aggregate, thus implements IOdiEntity interface. It is identified by a unique scenario ID that can be obtained from getScenarioId() method call. Equals / hashCode method are implemented according this identity. An OdiScenario can also be uniquely identified inside a given work repository by its Tag which is made of the scenario name and version.

Life cycle of an OdiScenario begins during design time code generation. Once generated, the scenario is stored inside the work repository (Design-time or Runtime work repository). The scenario can be exported then imported to another repository (remote or not) and executed inside ODI Execution Engine using different contexts (i.e. OdiContext). Also, a scenario is operated from the work repository it is stored in. The same scenario can be executed in several contexts from the same work repository. Life cycle ends when it is removed from runtime repository.

Note: The scenario code (the language generated) is frozen, and all subsequent modifications of the components that contributed to creating it will not change it in any way.

OdiScenario also provides APIs to get source component that serves to generate scenario. Note that in typical use case, scenario is exported from a design time repository and then imported in a runtime repository, and then you will not be able to find that source component from repository.

Since:

11.1.1.3.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OdiScenario.PromptParamType This Enum type indicates which variables will be prompted as scenario startup parameter.

Field Summary

Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity

STARTING_INTERNAL_VERSION

Method Summary

Modifier and Type	Method and Description
IExecutableStep	addStep(IExecutableStep step)
IExecutableSequence	createSequence(java.lang.String seqName, int incValue, java.lang.String colName, java.lang.String logicalSchemaName, int maxValue, java.lang.String nativeName, java.lang.String rowFilter, java.lang.String tableName, SequenceType seqType)
IExecutableStep	createStep(int stepNumber, java.lang.String stepName, StepType stepType)
IExecutableVariable	createVariable(java.lang.String varName, VariableType varType, java.lang.Object defaultVal, java.lang.String desc, boolean isReadOnly, ValuePersistence valPersistence, java.lang.Number order)
CecBehavior	getCecSessBehavior()
java.lang.Number	getCecSessPollIntv()
java.lang.String	getDescription() Gets description of this OdiScenario.
java.util.Collection	getFlexFieldsValues() Obtains flex fields values related to this IFlexFieldUser.
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	getIsMaterialized() Gets the IS_MATERIALIZED from SNP_SCEN
java.lang.Number	getMaxCecSess()
java.lang.String	getName() Gets the OdiScenario's tag name.
OdiScenario.PromptParamType	getPromptParamType() Returns the OdiScenario.PromptParamType for this scenario.
MapPhysicalDesign	getScenarioDeploySpec(OdiInstance odiInstance) A convenient method for finding physical design
java.lang.Number	getScenarioDeploySpecId() Get the physical design id from which this scenario is generated.
OdiScenarioFolder	getScenarioFolder() Returns the OdiScenarioFolder containing this OdiScenario.
java.lang.Number	getScenarioId() Gets the ID of this OdiScenario.
java.util.List	getScenarioReports() Obtains an unmodifiable list of this OdiScenario's execution reports.
java.util.Collection	getScenarioSchedules() Obtains an unmodifiable collection of the schedules created for this OdiScenario.
java.util.Collection	getScenarioSequences() Obtains an unmodifiable collection of the sequences that are used inside this OdiScenario.
java.util.List	getScenarioSteps() Obtains an unmodifiable list of the OdiScenarioStep in this OdiScenario.
java.util.Collection	getScenarioVariables() Obtains an unmodifiable collection of the variables that are used inside this OdiScenario.
int	getSnapshotNumber() Returns the snapshot number of this OdiScenario.
java.lang.Class	getSourceComponentClass()
java.io.Serializable	getSourceComponentId() Gets the ID of the source component (i.e.
java.lang.Number	getSourceMappingId()
java.util.List	getSteps()
Tag	getTag() Gets the OdiScenario's tag (name and version).
java.lang.String	getVersion() Gets the OdiScenario's tag version.
void	initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder) Initialize flex fields related to this IFlexFieldUser.
boolean	isInstanceLevelSecurityNeeded() Internal: this method is for internal purpose and must not be considered as part of the public API.
void	setCecSessBehavior(CecBehavior cecSessBehavior) Set the CecBehavior of this scenario that applies when getMaxCecSess() returns a positive value.
void	setCecSessPollIntv(java.lang.Number cecSessPollIntv) Set the polling interval (in seconds) that applies when getMaxCecSess() returns a positive value and getCecSessBehavior() is WAIT.
void	setMaxCecSess(java.lang.Number maxCecSess) Set the maximum number of allowed concurrent session executions for this scenario.
void	setPromptParamType(OdiScenario.PromptParamType promptParamType) Sets the OdiScenario.PromptParamType value for this scenario
void	setScenarioDeploySpecId(java.lang.Number pDeploySpecId) Set senario physical design.
void	setTag(Tag pTag) Specifies the tag for this OdiScenario.
boolean	wasGeneratedFromInterface() Returns whether this OdiScenario was generated from an Interface, or not.
boolean	wasGeneratedFromMapping()
boolean	wasGeneratedFromPackage() Returns whether this OdiScenario was generated from a Package, or not.
boolean	wasGeneratedFromUserProcedure() Returns whether this OdiScenario was generated from a User Procedure, or not.
boolean	wasGeneratedFromVariable() Returns whether this OdiScenario was generated from a Variable, or not.

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

getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, isNew, preCommit, toString

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

equals, getBigNumericId, getGlobalId, getNumericId, getParent, hashCode

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

clone

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.odi.domain.adapter.IModelObjectBase

getBigNumericId, getGlobalId, getNumericId

Methods inherited from interface oracle.odi.domain.IOdiEntity

getFirstDate, getFirstUser, getLastDate, getLastUser

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getParent

Constructor Detail

OdiScenario

public OdiScenario(Tag pTag)

Parameters:

pTag - scenario Tag

Method Detail

getTag

public Tag getTag()

Gets the OdiScenario's tag (name and version).

Returns:

the OdiScenario's tag (name and version)

getName

public java.lang.String getName()

Gets the OdiScenario's tag name.

Specified by:

getName in interface IFlexFieldUser

Specified by:

getName in interface IModelObject

Specified by:

getName in interface IOdiEntity

Overrides:

getName in class oracle.odi.domain.support.AbstractOdiEntity

Returns:

the OdiScenario's tag name

getVersion

public java.lang.String getVersion()

Gets the OdiScenario's tag version.

Specified by:

getVersion in interface IScenario

Returns:

the OdiScenario's tag version

getScenarioId

public java.lang.Number getScenarioId()

Gets the ID of this OdiScenario.

Returns:

the ID of this OdiScenario

isInstanceLevelSecurityNeeded

public boolean isInstanceLevelSecurityNeeded()

Description copied from interface: IOdiEntity

Internal: this method is for internal purpose and must not be considered as part of the public API.

Defines a method to capture the info on which object needs instance level privilege.

Specified by:

isInstanceLevelSecurityNeeded in interface IOdiEntity

Overrides:

isInstanceLevelSecurityNeeded in class oracle.odi.domain.support.AbstractOdiEntity

Returns:

true if instance level security needed, false otherwise

getDescription

public java.lang.String getDescription()

Gets description of this OdiScenario.

Returns:

description of this OdiScenario

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

Returns:

the persistence identity of this instance

getScenarioVariables

public java.util.Collection getScenarioVariables()

Obtains an unmodifiable collection of the variables that are used inside this OdiScenario.

Returns:

an unmodifiable collection of the variables that are used inside this OdiScenario

getScenarioSequences

public java.util.Collection getScenarioSequences()

Obtains an unmodifiable collection of the sequences that are used inside this OdiScenario.

Returns:

an unmodifiable collection of the sequences that are used inside this OdiScenario

getScenarioSchedules

public java.util.Collection getScenarioSchedules()

Obtains an unmodifiable collection of the schedules created for this OdiScenario.

Returns:

an unmodifiable collection of the schedules created for this OdiScenario

getScenarioReports

public java.util.List getScenarioReports()

Obtains an unmodifiable list of this OdiScenario's execution reports. The returned list is ordered by execution number.

Returns:

an unmodifiable list of this OdiScenario's execution reports

getSourceComponentId

public java.io.Serializable getSourceComponentId()

Gets the ID of the source component (i.e. Interface, Package, Variable or User Procedure) that was used to generate this OdiScenario.

Returns:

the ID of the source component

getSourceComponentClass

public java.lang.Class getSourceComponentClass()

wasGeneratedFromInterface

public boolean wasGeneratedFromInterface()

Returns whether this OdiScenario was generated from an Interface, or not.

Returns:

whether this OdiScenario was generated from an Interface, or not

wasGeneratedFromPackage

public boolean wasGeneratedFromPackage()

Returns whether this OdiScenario was generated from a Package, or not.

Specified by:

wasGeneratedFromPackage in interface IExecutable

Returns:

whether this OdiScenario was generated from a Package, or not

wasGeneratedFromVariable

public boolean wasGeneratedFromVariable()

Returns whether this OdiScenario was generated from a Variable, or not.

Returns:

whether this OdiScenario was generated from a Variable, or not

wasGeneratedFromUserProcedure

public boolean wasGeneratedFromUserProcedure()

Returns whether this OdiScenario was generated from a User Procedure, or not.

Returns:

whether this OdiScenario was generated from a User Procedure, or not

getSourceMappingId

public java.lang.Number getSourceMappingId()

getFlexFieldsValues

public java.util.Collection getFlexFieldsValues()

Description copied from interface: IFlexFieldUser

Obtains flex fields values related to this IFlexFieldUser. In most implementations method IFlexFieldUser.initFlexFields(IOdiFlexFieldFinder) should be called before calling this method.

Specified by:

getFlexFieldsValues in interface IFlexFieldUser

Returns:

an unmodifiable Collection of flex field values

initFlexFields

public void initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder)

Description copied from interface: IFlexFieldUser

Initialize flex fields related to this IFlexFieldUser.

Specified by:

initFlexFields in interface IFlexFieldUser

Parameters:

pOdiFlexFieldFinder - OdiFlexField finder to be used to query flex fields

getScenarioFolder

public OdiScenarioFolder getScenarioFolder()

Returns the OdiScenarioFolder containing this OdiScenario.

Returns:

the scenario folder

Since:

11.1.1.5.0

setScenarioDeploySpecId

public void setScenarioDeploySpecId(java.lang.Number pDeploySpecId)

Set senario physical design.

Parameters:

pDeploySpecId - The physical design Id from where this scenario is generated.

getScenarioDeploySpecId

public java.lang.Number getScenarioDeploySpecId()

Get the physical design id from which this scenario is generated.

Returns:

The physical design id.

getSnapshotNumber

public int getSnapshotNumber()

Returns the snapshot number of this OdiScenario. This is value incremented on scenario modification and regeneration.

This number is useful in identifying the scenario snapshot whether an existing session blueprint refers to the current scenario. If a session blueprint for a current scenario copy is available then that would be used for session execution otherwise a new session blueprint would be generated out of the current scenario snapshot.

Specified by:

getSnapshotNumber in interface IScenario

Returns:

snapshot number

Since:

12.1

See Also:

setSnapshotNumber(int)

setTag

public void setTag(Tag pTag)

Specifies the tag for this OdiScenario.

Parameters:

pTag -

getScenarioSteps

public java.util.List getScenarioSteps()

Obtains an unmodifiable list of the OdiScenarioStep in this OdiScenario.

Returns:

an unmodifiable list of the steps

wasGeneratedFromMapping

public boolean wasGeneratedFromMapping()

createStep

public IExecutableStep createStep(int stepNumber,
                                  java.lang.String stepName,
                                  StepType stepType)

Specified by:

createStep in interface IExecutable

addStep

public IExecutableStep addStep(IExecutableStep step)

Specified by:

addStep in interface IExecutable

createSequence

public IExecutableSequence createSequence(java.lang.String seqName,
                                          int incValue,
                                          java.lang.String colName,
                                          java.lang.String logicalSchemaName,
                                          int maxValue,
                                          java.lang.String nativeName,
                                          java.lang.String rowFilter,
                                          java.lang.String tableName,
                                          SequenceType seqType)

Specified by:

createSequence in interface IExecutable

createVariable

public IExecutableVariable createVariable(java.lang.String varName,
                                          VariableType varType,
                                          java.lang.Object defaultVal,
                                          java.lang.String desc,
                                          boolean isReadOnly,
                                          ValuePersistence valPersistence,
                                          java.lang.Number order)

Specified by:

createVariable in interface IExecutable

getSteps

public java.util.List getSteps()

Specified by:

getSteps in interface IExecutable

getScenarioDeploySpec

public MapPhysicalDesign getScenarioDeploySpec(OdiInstance odiInstance)

A convenient method for finding physical design

Returns:

MapPhysicalDesign that is used to generate this scenario

getPromptParamType

public OdiScenario.PromptParamType getPromptParamType()

Returns the OdiScenario.PromptParamType for this scenario. The default value is OdiScenarioPromptParamType.USE_ALL

Returns:

See Also:

OdiScenario.PromptParamType

setPromptParamType

public void setPromptParamType(OdiScenario.PromptParamType promptParamType)

Sets the OdiScenario.PromptParamType value for this scenario

Parameters:

promptParamType -

See Also:

OdiScenario.PromptParamType

getMaxCecSess

public java.lang.Number getMaxCecSess()

Returns:

the maximum number of allowed concurrent session executions for this scenario. If null or <= 0 then concurrent execution control is not enabled.

setMaxCecSess

public void setMaxCecSess(java.lang.Number maxCecSess)

Set the maximum number of allowed concurrent session executions for this scenario. If null or <= 0 then concurrent execution control is not enabled. For the 12.1.3 release, even if the value is > 1,the runtime still treats it as if its a value of 1 to allow only 1 session/LPR execution at a time.

Parameters:

maxCecSess -

getCecSessBehavior

public CecBehavior getCecSessBehavior()

Returns:

the CecBehavior of this scenario that applies when getMaxCecSess() returns a positive value.

setCecSessBehavior

public void setCecSessBehavior(CecBehavior cecSessBehavior)

Set the CecBehavior of this scenario that applies when getMaxCecSess() returns a positive value.

getCecSessPollIntv

public java.lang.Number getCecSessPollIntv()

Returns:

the polling interval (in seconds) that applies when getMaxCecSess() returns a positive value and getCecSessBehavior() is WAIT.

setCecSessPollIntv

public void setCecSessPollIntv(java.lang.Number cecSessPollIntv)

Set the polling interval (in seconds) that applies when getMaxCecSess() returns a positive value and getCecSessBehavior() is WAIT.

getIsMaterialized

public java.lang.String getIsMaterialized()

Gets the IS_MATERIALIZED from SNP_SCEN