public class OdiSessionBlueprint extends oracle.odi.domain.support.AbstractOdiEntity implements IWorkRuntimeOdiEntity, IExecutable
OdiSessionBlueprint
is SDK representation of Session Blueprint which is the copy of
one particular snapshot/revision of a OdiScenario
(or created directly from design time objects).
It holds the blueprint (execution plan) for a OdiSession
that would direct the execution flow and
the commands executed for the OdiSession
. It would be common across the executions for a OdiScenario
snapshot/revision. It does not change between different executions of the OdiScenario
until the
OdiScenario
is regenerated. After OdiScenario
regeneration a new OdiSessionBlueprint
object
would be created in repository that would be used for subsequent executions of that OdiScenario
. So
OdiSessionBlueprint
is not changed during its life-cycle. It is removed from repository if related
OdiScenario
is removed or regenerated and there are no OdiSession
referenced to this
OdiSessionBlueprint
.
External SDK users should use this object for read-only purpose.
Constructor and Description |
---|
OdiSessionBlueprint()
FOR INTERNAL USE ONLY.
|
OdiSessionBlueprint(java.lang.Number pSourceScenarioId,
java.lang.Number pSourceScenarioSnapshotNumber,
Tag pSourceScenarioTag)
FOR INTERNAL USE ONLY.
|
Modifier and Type | Method and Description |
---|---|
void |
addSessionBlueprintSequence(OdiSessionBlueprintSequence pSessionBlueprintSequence)
FOR INTERNAL USE ONLY.
|
void |
addSessionBlueprintStep(OdiSessionBlueprintStep pSessionBlueprintStep)
FOR INTERNAL USE ONLY.
|
void |
addSessionBlueprintVariable(OdiSessionBlueprintVariable pSessionBlueprintVariable)
FOR INTERNAL USE ONLY.
|
IExecutableStep |
addStep(IExecutableStep step) |
static void |
cleanup(IOdiEntityManager pEM,
java.lang.Number pScenId,
int pSnapshotNumber,
java.util.List pIssues)
Cleanup orphaned session blueprint for one scenario.
|
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) |
OdiSessionBlueprintBreakpoint |
getBreakpointOn(OdiSessionBlueprintStep pSessionBlueprintStep)
Returns breakpoint set on the step specified if any and
null
otherwise. |
OdiSessionBlueprintBreakpoint |
getBreakpointOn(OdiSessionBlueprintTask pSessionBlueprintTask)
Returns breakpoint set on the task specified if any and
null
otherwise. |
java.lang.Number |
getDeploySpecId()
Get the internal id of the deployment spec from which this session blueprint is generated.
|
java.lang.String |
getDescription()
Returns the description of this
OdiSessionBlueprint . |
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.Number |
getMappingId()
Get the internal id of the mapping from which this session blueprint is generated.
|
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities.
|
java.lang.Number |
getSessionBlueprintId()
Returns the ID of this
OdiSessionBlueprint . |
java.util.Collection |
getSessionBlueprintSequences()
Returns the unmodifiable collection of related
OdiSessionBlueprintSequence s. |
java.util.List |
getSessionBlueprintSteps()
Returns the unmodifiable collection of related
OdiSessionBlueprintStep s. |
java.util.Collection |
getSessionBlueprintVariables()
Returns the unmodifiable collection of related
OdiSessionBlueprintVariable s. |
java.lang.Number |
getSourceInterfaceId()
Returns the ID of interface, from which this
OdiSessionBlueprint or related OdiScenario
is generated. |
java.lang.Number |
getSourcePackageId()
Returns the ID of package, from which this
OdiSessionBlueprint or related OdiScenario
is generated. |
java.lang.Number |
getSourceProcedureId()
Returns the ID of procedure, from which this
OdiSessionBlueprint or related OdiScenario
is generated. |
java.lang.Number |
getSourceScenarioId()
Returns the ID of
OdiScenario , from which this OdiSessionBlueprint
was generated, or null if it was generated from the design-time object. |
java.lang.Number |
getSourceScenarioSnapshotNumber()
Returns the snapshot number of
OdiScenario , from which this OdiSessionBlueprint
was generated, or null if it was generated from the design-time object. |
Tag |
getSourceScenarioTag()
Returns the
Tag of OdiScenario , from which this OdiSessionBlueprint
was generated, or null if it was generated from the design-time object. |
java.lang.Number |
getSourceVariableId()
Returns the ID of variable, from which this
OdiSessionBlueprint or related OdiScenario
is generated. |
java.util.List |
getSteps() |
void |
removeBreakpointOn(OdiSessionBlueprintStep pSessionBlueprintStep)
Removes breakpoint on the step specified.
|
void |
removeBreakpointOn(OdiSessionBlueprintTask pSessionBlueprintTask)
Removes breakpoint on the task specified.
|
OdiSessionBlueprintBreakpoint |
setBreakpointOn(OdiSessionBlueprintStep pSessionBlueprintStep)
Sets breakpoint on the step specified.
|
OdiSessionBlueprintBreakpoint |
setBreakpointOn(OdiSessionBlueprintTask pSessionBlueprintTask)
Sets breakpoint on the task specified.
|
void |
setDeploySpecId(java.lang.Number pDeploySpecId)
Set deployment spec intenral id on this session blueprint
|
void |
setDescription(java.lang.String pDescription)
FOR INTERNAL USE ONLY.
|
void |
setMappingId(java.lang.Number pMappingId)
Set mapping internal id on this session blueprint
|
void |
setSourceInterfaceId(java.lang.Number pSourceInterfaceId)
FOR INTERNAL USE ONLY.
|
void |
setSourcePackageId(java.lang.Number pSourcePackageId)
FOR INTERNAL USE ONLY.
|
void |
setSourceProcedureId(java.lang.Number pSourceProcedureId)
FOR INTERNAL USE ONLY.
|
void |
setSourceScenarioId(java.lang.Number pSourceScenarioId)
Set the ID of
OdiScenario . |
void |
setSourceVariableId(java.lang.Number pSourceVariableId)
FOR INTERNAL USE ONLY.
|
boolean |
wasGeneratedFromPackage() |
equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, getName, hashCode, isInstanceLevelSecurityNeeded, isNew, toString
getGlobalId, getNumericId, hasCustomizedPersistenceMethodFor, invokeCustomizedPersistenceMethodFor
getFirstDate, getFirstUser, getLastDate, getLastUser, getName, isInstanceLevelSecurityNeeded
getGlobalId
public OdiSessionBlueprint(java.lang.Number pSourceScenarioId, java.lang.Number pSourceScenarioSnapshotNumber, Tag pSourceScenarioTag)
Constructs OdiSessionBlueprint
object for specified scenario information.
Use OdiSessionBlueprint()
constructor for blueprints generated on the
design-time object executions.
pSourceScenarioId
- scenario IDpSourceScenarioSnapshotNumber
- scenario snapshot/revision numberpSourceScenarioTag
- scenario Tagpublic OdiSessionBlueprint()
Constructs OdiSessionBlueprint
object for direct design-time object execution.
public static void cleanup(IOdiEntityManager pEM, java.lang.Number pScenId, int pSnapshotNumber, java.util.List pIssues)
pEM
- - Eclipselink entity manager for accessing persistence backend.scen
- - The scenario whose session blueprints are to be purgedpublic java.lang.Number getSessionBlueprintId()
OdiSessionBlueprint
.public java.lang.Number getSourceScenarioId()
OdiScenario
, from which this OdiSessionBlueprint
was generated, or null if it was generated from the design-time object.public void setSourceScenarioId(java.lang.Number pSourceScenarioId)
OdiScenario
.pSourceScenarioId
- public java.lang.Number getSourceScenarioSnapshotNumber()
OdiScenario
, from which this OdiSessionBlueprint
was generated, or null if it was generated from the design-time object.public java.lang.Number getSourceInterfaceId()
OdiSessionBlueprint
or related OdiScenario
is generated.public java.lang.Number getSourceProcedureId()
OdiSessionBlueprint
or related OdiScenario
is generated.public java.lang.Number getSourcePackageId()
OdiSessionBlueprint
or related OdiScenario
is generated.public java.lang.Number getSourceVariableId()
OdiSessionBlueprint
or related OdiScenario
is generated.public java.lang.Number getMappingId()
public java.lang.Number getDeploySpecId()
public java.lang.String getDescription()
OdiSessionBlueprint
.public java.util.Collection getSessionBlueprintVariables()
OdiSessionBlueprintVariable
s.public void addSessionBlueprintVariable(OdiSessionBlueprintVariable pSessionBlueprintVariable)
Adds the variable to this OdiSessionBlueprint
.
pSessionBlueprintVariable
- blueprint variable to addpublic java.util.List getSessionBlueprintSteps()
OdiSessionBlueprintStep
s.public void addSessionBlueprintStep(OdiSessionBlueprintStep pSessionBlueprintStep)
Adds the step to this OdiSessionBlueprint
.
pSessionBlueprintStep
- blueprint step to addpublic java.util.Collection getSessionBlueprintSequences()
OdiSessionBlueprintSequence
s.public void addSessionBlueprintSequence(OdiSessionBlueprintSequence pSessionBlueprintSequence)
Adds the sequence to this OdiSessionBlueprint
.
pSessionBlueprintSequence
- blueprint sequence to addpublic java.io.Serializable getInternalId()
IRepositoryEntity
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.
getInternalId
in interface IRepositoryEntity
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public Tag getSourceScenarioTag()
Tag
of OdiScenario
, from which this OdiSessionBlueprint
was generated, or null if it was generated from the design-time object.public void setSourceInterfaceId(java.lang.Number pSourceInterfaceId)
Sets the ID of interface, from which this OdiSessionBlueprint
or related OdiScenario
is generated.
pSourceInterfaceId
- interface IDpublic void setSourceProcedureId(java.lang.Number pSourceProcedureId)
Sets the ID of procedure, from which this OdiSessionBlueprint
or related OdiScenario
is generated.
pSourceProcedureId
- procedure IDpublic void setSourcePackageId(java.lang.Number pSourcePackageId)
Sets the ID of package, from which this OdiSessionBlueprint
or related OdiScenario
is generated.
pSourcePackageId
- package IDpublic void setSourceVariableId(java.lang.Number pSourceVariableId)
Sets the ID of variable, from which this OdiSessionBlueprint
or related OdiScenario
is generated.
pSourceVariableId
- variable IDpublic void setMappingId(java.lang.Number pMappingId)
pMappingId
- - the mapping internal id to be setpublic void setDeploySpecId(java.lang.Number pDeploySpecId)
pDeploySpecId
- - the deployment spec internal id to be setpublic void setDescription(java.lang.String pDescription)
Sets the description for this OdiSessionBlueprint
. Usually, it is the copy of
OdiScenario
description.
pDescription
- description to setpublic OdiSessionBlueprintBreakpoint setBreakpointOn(OdiSessionBlueprintStep pSessionBlueprintStep)
pSessionBlueprintStep
- step to set breakpoint ongetBreakpointOn(OdiSessionBlueprintStep)
,
removeBreakpointOn(OdiSessionBlueprintStep)
public OdiSessionBlueprintBreakpoint getBreakpointOn(OdiSessionBlueprintStep pSessionBlueprintStep)
null
otherwise.pSessionBlueprintStep
- step to get breakpoint onsetBreakpointOn(OdiSessionBlueprintStep)
,
removeBreakpointOn(OdiSessionBlueprintStep)
public void removeBreakpointOn(OdiSessionBlueprintStep pSessionBlueprintStep)
pSessionBlueprintStep
- step to remove breakpoint onsetBreakpointOn(OdiSessionBlueprintStep)
,
getBreakpointOn(OdiSessionBlueprintStep)
public OdiSessionBlueprintBreakpoint setBreakpointOn(OdiSessionBlueprintTask pSessionBlueprintTask)
pSessionBlueprintTask
- task to set breakpoint ongetBreakpointOn(OdiSessionBlueprintTask)
,
removeBreakpointOn(OdiSessionBlueprintTask)
public OdiSessionBlueprintBreakpoint getBreakpointOn(OdiSessionBlueprintTask pSessionBlueprintTask)
null
otherwise.pSessionBlueprintTask
- task to get breakpoint onsetBreakpointOn(OdiSessionBlueprintTask)
,
removeBreakpointOn(OdiSessionBlueprintTask)
public void removeBreakpointOn(OdiSessionBlueprintTask pSessionBlueprintTask)
pSessionBlueprintTask
- task to remove breakpoint onsetBreakpointOn(OdiSessionBlueprintTask)
,
getBreakpointOn(OdiSessionBlueprintTask)
public IExecutableStep createStep(int stepNumber, java.lang.String stepName, StepType stepType)
createStep
in interface IExecutable
public IExecutableStep addStep(IExecutableStep step)
addStep
in interface IExecutable
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)
createSequence
in interface IExecutable
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)
createVariable
in interface IExecutable
public java.util.List getSteps()
getSteps
in interface IExecutable
public boolean wasGeneratedFromPackage()
wasGeneratedFromPackage
in interface IExecutable