|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.6.0) E17060-03 |
|||||||||
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.scheduling.OdiSchedule
oracle.odi.domain.runtime.scenario.OdiScenarioSchedule
public final class OdiScenarioSchedule
OdiScenarioSchedule is an execution schedule attached to the concrete OdiScenario
, specified on the object construction. Once created OdiScenarioSchedule cannot be reassigned to another OdiScenario
. Much of API is defined in OdiSchedule
class, which is the superclass for OdiScenarioSchedule. The main purpose of this concrete class is to include OdiScenario
object to which the schedule applies, and provide creation of valid startup parameters for OdiSession
.
OdiScenarioSchedule is the part of aggregation with some OdiScenario
). It is important to understand that a OdiScenarioSchedule concerns only one scenario and once created it cannot be separated from that particular scenario, while the latest can have several schedules and can be scheduled in several ways. OdiScenarioSchedule life cycle begins when a user constructs a new instance specifying OdiScenario
. It is then stored inside ODI run-time repository. Life cycle ends when a user deletes the concrete implementation or the related scenario from run-time repository (i.e. using IOdiEntityManager.remove()).
The main purpose of this class is to include OdiScenario
object to which the schedule applies, and provide creation of valid startup parameters for OdiSession
.
OdiSchedule
, OdiScenario
, OdiJobStartupParam
, Serialized FormField Summary |
---|
Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity |
---|
STARTING_INTERNAL_VERSION |
Constructor Summary | |
---|---|
OdiScenarioSchedule(OdiScenario pScenario, java.lang.String pContextCode, java.lang.String pLogicalAgentName) Constructs the active schedule of ON_AGENT_STARTUP recurrence type for specified OdiScenario . |
|
OdiScenarioSchedule(OdiScenario pScenario, java.lang.String pContextCode, java.lang.String pLogicalAgentName, Recurrence pRecurrence) Constructs the active Schedule with specified recurrence for specified OdiScenario . |
Method Summary | |
---|---|
OdiJobStartupParam |
createJobStartupParam(OdiScenarioVariable pVariable, java.lang.Object pValue) Creates a new instance of OdiJobStartupParam and associate it with the schedule. |
OdiScenario |
getScenario() Returns the OdiScenario this schedule is associated with. |
IRepositoryEntity |
getSecurityContainer() Define a generic way to retrieve container for entities. |
void |
setExecutionMode(ExecutionMode pExecutionMode) Sets the execution mode for ODI session to be executed. |
Methods inherited from class oracle.odi.domain.support.AbstractOdiEntity |
---|
equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, getName, hashCode, isInstanceLevelSecurityNeeded, 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, getName, isInstanceLevelSecurityNeeded |
Constructor Detail |
---|
public OdiScenarioSchedule(OdiScenario pScenario, java.lang.String pContextCode, java.lang.String pLogicalAgentName)
OdiScenario
.
pScenario
- scenariopContextCode
- context codepLogicalAgentName
- logical agent nameDomainRuntimeException
- if scenario is null; context code or logical agent name is null or emptyRecurrence
public OdiScenarioSchedule(OdiScenario pScenario, java.lang.String pContextCode, java.lang.String pLogicalAgentName, Recurrence pRecurrence)
OdiScenario
.
pScenario
- scenariopContextCode
- context codepLogicalAgentName
- logical agent namepRecurrence
- recurrenceDomainRuntimeException
- if scenario or recurrence is null; context code or logical agent name is null or emptyRecurrence
Method Detail |
---|
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
public OdiScenario getScenario()
OdiScenario
this schedule is associated with.OdiScenario
public void setExecutionMode(ExecutionMode pExecutionMode)
This method is overridden to prohibit nulls, because execution mode is mandatory attribute for scenario schedules.
setExecutionMode
in class OdiSchedule
pExecutionMode
- execution mode to setDomainRuntimeException
- if specified execution mode is nullExecutionMode
, OdiSchedule.getExecutionMode()
public OdiJobStartupParam createJobStartupParam(OdiScenarioVariable pVariable, java.lang.Object pValue)
OdiJobStartupParam
and associate it with the schedule. The latest value of the given OdiScenarioVariable
will be overridden with the given value.pVariable
- scenario variablepValue
- valueDomainRuntimeException
- if variable is null or not related to the same scenarioOdiJobStartupParam
, OdiScenarioVariable
, OdiSchedule.removeJobStartupParam(OdiJobStartupParam)
, OdiSchedule.getJobStartupParams()
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.6.0) E17060-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |