public final class OdiLoadPlanSchedule extends OdiSchedule
OdiLoadPlanSchedule is an execution schedule attached to the concrete
OdiLoadPlan
, specified on the object construction. Once created
OdiLoadPlanSchedule cannot be reassigned to another OdiLoadPlan
. Much
of API is defined in OdiSchedule
class, which is the superclass for
OdiLoadPlanSchedule. The main purpose of this concrete class is to include
OdiLoadPlan
object to which the schedule applies, and provide creation
of valid startup parameters for OdiLoadPlanInstance
.
OdiLoadPlanSchedule is the part of aggregation with some OdiLoadPlan
).
It is important to understand that a OdiLoadPlanSchedule concerns only one load
plan and once created it cannot be separated from that particular load plan,
while the latest can have several schedules and can be scheduled in several
ways. OdiLoadPlanSchedule life cycle begins when a user constructs a new
instance specifying OdiLoadPlan
. It is then stored inside ODI run-time
repository. Life cycle ends when a user deletes the concrete implementation or
the related load plan from run-time repository (i.e. using
IOdiEntityManager.remove()).
OdiSchedule
,
OdiLoadPlan
,
OdiJobStartupParam
,
Serialized FormConstructor and Description |
---|
OdiLoadPlanSchedule(OdiLoadPlan pLoadPlan,
java.lang.String pContextCode,
java.lang.String pLogicalAgentName)
Constructs the active schedule of ON_AGENT_STARTUP recurrence type for
specified
OdiLoadPlan . |
OdiLoadPlanSchedule(OdiLoadPlan pLoadPlan,
java.lang.String pContextCode,
java.lang.String pLogicalAgentName,
Recurrence pRecurrence)
Constructs the active Schedule with specified recurrence for specified
OdiLoadPlan . |
Modifier and Type | Method and Description |
---|---|
OdiJobStartupParam |
createJobStartupParam(OdiLoadPlanVariable pVariable,
java.lang.Object pValue)
Creates a new instance of
OdiJobStartupParam and associate it with
the schedule. |
OdiLoadPlan |
getLoadPlan()
Returns the
OdiLoadPlan this schedule is associated with. |
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities.
|
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, setExecutionMode, setLogicalAgentName, setMaxRunDuration, setName, setRecurrence, setRepetition, setStatus
equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, isInstanceLevelSecurityNeeded, isNew, preCommit, toString
getGlobalId, getNumericId, hasCustomizedPersistenceMethodFor, invokeCustomizedPersistenceMethodFor
getFirstDate, getFirstUser, getLastDate, getLastUser, isInstanceLevelSecurityNeeded
getGlobalId
public OdiLoadPlanSchedule(OdiLoadPlan pLoadPlan, java.lang.String pContextCode, java.lang.String pLogicalAgentName)
OdiLoadPlan
.pLoadPlan
- load planpContextCode
- context codepLogicalAgentName
- logical agent nameDomainRuntimeException
- if load plan is null; context code or
logical agent name is null or emptyRecurrence
public OdiLoadPlanSchedule(OdiLoadPlan pLoadPlan, java.lang.String pContextCode, java.lang.String pLogicalAgentName, Recurrence pRecurrence)
OdiLoadPlan
.pLoadPlan
- load planpContextCode
- context codepLogicalAgentName
- logical agent namepRecurrence
- recurrenceDomainRuntimeException
- if load plan or recurrence is null; context
code or logical agent name is null or emptyRecurrence
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
public OdiLoadPlan getLoadPlan()
OdiLoadPlan
this schedule is associated with.OdiLoadPlan
public OdiJobStartupParam createJobStartupParam(OdiLoadPlanVariable pVariable, java.lang.Object pValue)
OdiJobStartupParam
and associate it with
the schedule. The latest value of the given OdiLoadPlanVariable
will
be overridden with the given value.pVariable
- load plan variablepValue
- valueDomainRuntimeException
- if variable is null or not related to the
same load planOdiJobStartupParam
,
OdiLoadPlanVariable
,
OdiSchedule.removeJobStartupParam(OdiJobStartupParam)
,
OdiSchedule.getJobStartupParams()