public final class OdiScenarioSchedule extends OdiSchedule
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 FormConstructor and Description |
---|
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 . |
Modifier and Type | Method and Description |
---|---|
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.
|
getActiveFromDate, getActiveToDate, getAttemptNbOnFailure, getContextCode, getDailyActivationTimeRange, getExcludedMonthDaysPattern, getExcludedWeekDays, getExecutionMode, getInternalId, getJobStartupParams, getLogicalAgentName, getMaxRunDuration, getName, getRecurrence, getRepetition, getScheduleId, getStatus, removeJobStartupParam, setActiveFromDate, setActiveToDate, setAttemptNbOnFailure, setContextCode, setDailyActivationTimeRange, setExcludedMonthDaysPattern, setExcludedWeekDays, setLogicalAgentName, setMaxRunDuration, setName, setRecurrence, setRepetition, setStatus
equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, isInstanceLevelSecurityNeeded, isNew, toString
getGlobalId, getNumericId, hasCustomizedPersistenceMethodFor, invokeCustomizedPersistenceMethodFor
getFirstDate, getFirstUser, getLastDate, getLastUser, isInstanceLevelSecurityNeeded
getGlobalId
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
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()