|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.odi.domain.support.BusinessObject oracle.odi.domain.support.AbstractRepositoryEntity oracle.odi.domain.support.AbstractOdiEntity oracle.odi.domain.runtime.scenario.OdiScenario
public final class OdiScenario
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.
For now it is not possible to create an OdiScenario
.
Field Summary |
---|
Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity |
---|
STARTING_INTERNAL_VERSION |
Method Summary | |
---|---|
java.lang.String |
getDescription()
Gets description of this OdiScenario . |
java.util.Collection<IFlexFieldValue> |
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 |
getName()
Gets the OdiScenario's tag name. |
java.lang.Number |
getScenarioId()
Gets the ID of this OdiScenario . |
java.util.List<OdiScenarioReport> |
getScenarioReports()
Obtains an unmodifiable list of this OdiScenario's execution reports. |
java.util.Collection<OdiScenarioSequence> |
getScenarioSequences()
Obtains an unmodifiable collection of the sequences that are used inside this OdiScenario . |
java.util.Collection<OdiScenarioVariable> |
getScenarioVariables()
Obtains an unmodifiable collection of the variables that are used inside this OdiScenario . |
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities. |
java.io.Serializable |
getSourceComponentId()
Gets the ID of the source component (i.e. |
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. |
boolean |
wasGeneratedFromInterface()
Returns whether this OdiScenario was generated from an Interface , or not. |
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 |
---|
equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, isNew, toString |
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.IOdiEntity |
---|
getFirstDate, getFirstUser, getLastDate, getLastUser |
Method Detail |
---|
public java.lang.String getDescription()
OdiScenario
.
OdiScenario
public java.util.Collection<IFlexFieldValue> getFlexFieldsValues()
IFlexFieldUser
IFlexFieldUser
.
getFlexFieldsValues
in interface IFlexFieldUser
public 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 java.lang.String getName()
getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
public java.lang.Number getScenarioId()
OdiScenario
.
OdiScenario
public java.util.List<OdiScenarioReport> getScenarioReports()
public java.util.Collection<OdiScenarioSequence> getScenarioSequences()
OdiScenario
.
OdiScenario
public java.util.Collection<OdiScenarioVariable> getScenarioVariables()
OdiScenario
.
OdiScenario
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public java.io.Serializable getSourceComponentId()
Interface
, Package
,
Variable
or User Procedure
) that was used to generate this
OdiScenario
.
public Tag getTag()
public java.lang.String getVersion()
public void initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder)
IFlexFieldUser
IFlexFieldUser
.
initFlexFields
in interface IFlexFieldUser
pOdiFlexFieldFinder
- OdiFlexField
finder to be used to query flex fieldspublic boolean isInstanceLevelSecurityNeeded()
IOdiEntity
Defines a method to capture the info on which object needs instance level privilege.
isInstanceLevelSecurityNeeded
in interface IOdiEntity
isInstanceLevelSecurityNeeded
in class oracle.odi.domain.support.AbstractOdiEntity
true
if instance level security needed,
false
otherwisepublic boolean wasGeneratedFromInterface()
OdiScenario
was generated from an Interface
, or not.
OdiScenario
was generated from an Interface
, or notpublic boolean wasGeneratedFromPackage()
OdiScenario
was generated from a Package
, or not.
OdiScenario
was generated from a Package
, or notpublic boolean wasGeneratedFromUserProcedure()
OdiScenario
was generated from a User Procedure
, or not.
OdiScenario
was generated from a User Procedure
, or notpublic boolean wasGeneratedFromVariable()
OdiScenario
was generated from a Variable
, or not.
OdiScenario
was generated from a Variable
, or not
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |