Skip navigation links
oracle.odi.domain.runtime.loadplan
Class OdiLoadPlanSchedule
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.loadplan.OdiLoadPlanSchedule
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Cloneable, IOdiEntity, IRepositoryEntity, IWorkRuntimeOdiEntity
-
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()).
- Since:
- 11.1.1.6.0
- See Also:
OdiSchedule
, OdiLoadPlan
, OdiJobStartupParam
, Serialized Form
Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity |
STARTING_INTERNAL_VERSION |
Methods inherited from class oracle.odi.domain.runtime.scheduling.OdiSchedule |
getActiveFromDate, getActiveToDate, getAttemptNbOnFailure, getContextCode, getDailyActivationTimeRange, getExcludedMonthDaysPattern, getExcludedWeekDays, getExecutionMode, getInternalId, getJobStartupParams, getLogicalAgentName, getMaxRunDuration, getRecurrence, getRepetition, getScheduleId, getStatus, removeJobStartupParam, setActiveFromDate, setActiveToDate, setAttemptNbOnFailure, setContextCode, setDailyActivationTimeRange, setExcludedMonthDaysPattern, setExcludedWeekDays, setExecutionMode, setLogicalAgentName, setMaxRunDuration, setRecurrence, setRepetition, setStatus |
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 |
OdiLoadPlanSchedule
public OdiLoadPlanSchedule(OdiLoadPlan pLoadPlan,
java.lang.String pContextCode,
java.lang.String pLogicalAgentName)
- Constructs the active schedule of ON_AGENT_STARTUP recurrence type for specified
OdiLoadPlan
.
- Parameters:
pLoadPlan
- load plan
pContextCode
- context code
pLogicalAgentName
- logical agent name
- Throws:
DomainRuntimeException
- if load plan is null; context code or logical agent name is null or empty
- See Also:
Recurrence
OdiLoadPlanSchedule
public OdiLoadPlanSchedule(OdiLoadPlan pLoadPlan,
java.lang.String pContextCode,
java.lang.String pLogicalAgentName,
Recurrence pRecurrence)
- Constructs the active Schedule with specified recurrence for specified
OdiLoadPlan
.
- Parameters:
pLoadPlan
- load plan
pContextCode
- context code
pLogicalAgentName
- logical agent name
pRecurrence
- recurrence
- Throws:
DomainRuntimeException
- if load plan or recurrence is null; context code or logical agent name is null or empty
- See Also:
Recurrence
getSecurityContainer
public IRepositoryEntity getSecurityContainer()
- Description copied from interface:
IRepositoryEntity
- Define a generic way to retrieve container for entities.
-
- Returns:
- container entity
getLoadPlan
public OdiLoadPlan getLoadPlan()
- Returns the
OdiLoadPlan
this schedule is associated with.
-
- Returns:
- load plan
- See Also:
OdiLoadPlan
createJobStartupParam
public OdiJobStartupParam createJobStartupParam(OdiLoadPlanVariable pVariable,
java.lang.Object pValue)
- Creates a new instance of
OdiJobStartupParam
and associate it with the schedule. The latest value of the given OdiLoadPlanVariable
will be overridden with the given value.
-
- Parameters:
pVariable
- load plan variable
pValue
- value
- Returns:
- created startup parameter
- Throws:
DomainRuntimeException
- if variable is null or not related to the same load plan
- See Also:
OdiJobStartupParam
, OdiLoadPlanVariable
, OdiSchedule.removeJobStartupParam(OdiJobStartupParam)
, OdiSchedule.getJobStartupParams()
Skip navigation links
Copyright © 2011, Oracle and/or its affiliates. All rights reserved.