|
Oracle Enterprise Scheduler Java API Reference 11g Release 1 (11.1.1.7) E26229-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.as.scheduler.BaseMetadata<JobSet>
oracle.as.scheduler.JobSet
public class JobSet
This class represents a JobSet. A JobSet is a collection of JobDefinitions or other JobSet definitions grouped together to run as a single unit in the scheduling system. Every JobDefinition or JobSet definition included within a given JobDefinition is known as step.
Steps within a JobSet can run either in serial or in parallel mode. In case of serial execution, the JobSet also supports conditional branching based on the execution status of the previous step. For example within a serial JobSet JS, consisting of JobDefinitions J1, J2, and J3, the step J2 can be defined to run if and only if J1 completes successfully. Similarly J3 can be defined to run if J2 finishes with Success or Warning.
Nested Class Summary | |
---|---|
static class |
JobSet.ExecutionMode Enums to indicate the execution mode for the JobSet. |
Field Summary | |
---|---|
static java.lang.String |
STEPID_DELIMITER |
Constructor Summary | |
---|---|
JobSet(java.lang.String name, java.lang.String description, JobSet.ExecutionMode mode) Constructs a JobSet with basic attributes. |
|
JobSet(java.lang.String name, java.lang.String description, JobSet.ExecutionMode mode, MetadataObjectId objectId) Constructs a JobSet. |
|
JobSet(java.lang.String name, java.lang.String description, JobSet.ExecutionMode mode, ParameterList parameters, JobSetStep[] steps) Constructs a nearly fully defined JobSet. |
|
JobSet(java.lang.String name, java.lang.String description, JobSet.ExecutionMode mode, ParameterList parameters, JobSetStep[] steps, java.lang.String firstStep) Constructs a fully defined JobSet. |
|
JobSet(java.lang.String name, java.lang.String displayName, java.lang.String description, JobSet.ExecutionMode mode, MetadataObjectId objectId) Constructs a JobSet. |
|
JobSet(java.lang.String name, java.lang.String displayNameKey, java.lang.String descriptionKey, JobSet.ExecutionMode mode, ParameterList parameters, JobSetStep[] steps, java.lang.String[] resourceBundleIDs) Constructs a nearly fully defined JobSet. |
|
JobSet(java.lang.String name, java.lang.String displayNameKey, java.lang.String descriptionKey, JobSet.ExecutionMode mode, ParameterList parameters, JobSetStep[] steps, java.lang.String firstStep, java.lang.String[] resourceBundleIDs) Constructs a fully defined JobSet and associate the JobSet definition with a set of resource bundles. |
|
JobSet(java.lang.String name, java.lang.String displayNameKey, java.lang.String descriptionKey, JobSet.ExecutionMode mode, java.lang.String[] resourceBundleIDs) Constructs a JobSet with basic attributes. |
Method Summary | |
---|---|
void |
addStep(JobSetStep step) Adds the given step to this JobSet. |
JobSet |
clone(java.lang.String newName) |
JobSetStep |
deleteStep(java.lang.String stepId) Deletes the JobSet step with the given step id. |
boolean |
equals(java.lang.Object obj) Compares an object for equality with this JobSet object. |
static JobSet |
from(javax.management.openmbean.CompositeData cd) Create an instance of the model specific class out of an associated CompositeData instance |
java.util.HashMap<java.lang.String,JobSetStep> |
getAllSteps() Returns a HashMap that contains all of the steps in this JobSet and all steps in any JobSet that is nested in this JobSet . |
BaseMetadataType<JobSet> |
getBaseMetadataType() |
JobSet.ExecutionMode |
getExecutionMode() Checks whether this JobSet is a serial or a parallel JobSet. |
java.lang.String |
getFirstStep() Returns the id of the first or starting step in a serial JobSet. |
java.util.HashMap<java.lang.String,JobSetStep> |
getJobSetSteps() Deprecated. Replaced by getJsSteps() |
java.util.List<JobSetStep> |
getJsSteps() Returns a List that contains the steps in this JobSet . |
ParameterList |
getParameters() Returns all the parameters defined for this JobSet |
protected JobSet |
getSelf() |
JobSetStep |
getStep(java.lang.String stepId) Gets the JobSet step with the given step id. |
org.w3c.dom.Document |
getSteps() Deprecated. Replaced by getJsSteps() . |
void |
setExecutionMode(JobSet.ExecutionMode mode) Sets the JobSet execution mode to either serial or parallel mode. |
void |
setFirstStep(java.lang.String firstStep) Sets the unique id of the first step to run for a serial JobSet. |
void |
setJobSetSteps(JobSetStep[] steps) Deprecated. Replaced by setJsSteps(JobSetStep[]) . |
void |
setJsSteps(JobSetStep[] steps) Sets the steps for this jobset to the given steps. |
void |
setParameters(ParameterList params) Sets the parameters of this JobSet. |
void |
setSteps(org.w3c.dom.Document doc, java.lang.String firstStep) Deprecated. Replaced by setJsSteps(JobSetStep[]) . |
javax.management.openmbean.CompositeData |
toCompositeData(javax.management.openmbean.CompositeType ct) |
static javax.management.openmbean.CompositeType |
toCompositeType() Returns the CompositeType that describes this model specific class |
java.lang.String |
toDebugString() Returns a debug string representation for this JobSet object. |
protected void |
validateCustom() Validates this JobSet. |
void |
validateForExecution() Validates this JobSet for execution. |
Methods inherited from class oracle.as.scheduler.BaseMetadata |
---|
from, getDescription, getDescriptionKey, getDisplayName, getDisplayNameKey, getMessages, getMetadataObjectId, getName, getResourceBundles, hashCode, localize, setDescription, setDescriptionKey, setDisplayName, setDisplayNameKey, setResourceBundles, toCompositeData, toString, validate |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String STEPID_DELIMITER
Constructor Detail |
---|
public JobSet(java.lang.String name, java.lang.String description, JobSet.ExecutionMode mode)
name
- name of the JobSet definition to be created. The name is also used as the default display name unless otherwise specifially set.description
- optional description for the JobSet definition. A null value is acceptable.mode
- true for serial JobSet, false for parallel JobSet.public JobSet(java.lang.String name, java.lang.String displayNameKey, java.lang.String descriptionKey, JobSet.ExecutionMode mode, java.lang.String[] resourceBundleIDs)
name
- name of the JobSet definition to be created. The name is also used as the default display name unless otherwise specifially set.displayNameKey
- the key of the entry in the resourcebundles to lookup the name. Optional.descriptionKey
- the key of the entry in the resourcebundles to lookup the description. Optional.mode
- true for serial JobSet, false for parallel JobSet.resourceBundleIDs
- an array of resource bundle id. Optional.public JobSet(java.lang.String name, java.lang.String description, JobSet.ExecutionMode mode, MetadataObjectId objectId)
MetadataService
to populate the unique identifier of this object(definition) within the metadata repository.
name
- name of the JobSet definition to be created. The name is also used as the default display name unless otherwise specifially set.description
- optional description for the JobSet definition. A null value is acceptable.mode
- true for serial JobSet, false for parallel JobSet.objectId
- unique identifier of this object in the metadata repository. The identifier is set which this object is retrieved via MetadataService
.public JobSet(java.lang.String name, java.lang.String displayName, java.lang.String description, JobSet.ExecutionMode mode, MetadataObjectId objectId)
MetadataService
to populate the unique identifier of this object(definition) within the metadata repository.
name
- name of the JobSet definition to be created.description
- optional description for the JobSet definition. A null value is acceptable.mode
- true for serial JobSet, false for parallel JobSet.objectId
- unique identifier of this object in the metadata repository. The identifier is set which this object is retrieved via MetadataService
.public JobSet(java.lang.String name, java.lang.String description, JobSet.ExecutionMode mode, ParameterList parameters, JobSetStep[] steps)
setFirstStep
.
name
- name for the JobSet definition to be created. The name is also used as the default display name unless otherwise specifially set.description
- optional description field for the JobSet.mode
- flag to indicate execution mode, true must be passed for a serial JobSet, false for parallel JobSet.parameters
- Parameters declared at the JobSet level.steps
- array of JobSetStep objects that represent the steps for this jobset. This is required for a Serial JobSet. The step id must be a valid step id from within the XML document specifying the steps.public JobSet(java.lang.String name, java.lang.String displayNameKey, java.lang.String descriptionKey, JobSet.ExecutionMode mode, ParameterList parameters, JobSetStep[] steps, java.lang.String[] resourceBundleIDs)
setFirstStep
.
name
- name of the JobSet definition to be created. The name is also used as the default display name unless otherwise specifially set.displayNameKey
- the key of the entry in the resourcebundles to lookup the name. Optional.descriptionKey
- the key of the entry in the resourcebundles to lookup the description. Optional.mode
- flag to indicate execution mode, true must be passed for a serial JobSet, false for parallel JobSet.parameters
- Parameters declared at the JobSet level.steps
- array of JobSetStep objects that represent the steps for this jobset.resourceBundleIDs
- an array of resource bundle id. Optional This is required for a Serial JobSet. The step id must be a valid step id from within the XML document specifying the steps.public JobSet(java.lang.String name, java.lang.String description, JobSet.ExecutionMode mode, ParameterList parameters, JobSetStep[] steps, java.lang.String firstStep)
name
- name for the JobSet definition to be created. The name is also used as the default display name unless otherwise specifially set.description
- optional description field for the JobSet.mode
- flag to indicate execution mode, true must be passed for a serial JobSet, false for parallel JobSet.parameters
- Parameters declared at the JobSet level.steps
- array of JobSetStep objects that represent the steps for this jobset.firstStep
- unique identifier of the step where execution begins for a serial jobset. This parameter is ignored for a parallel jobset.public JobSet(java.lang.String name, java.lang.String displayNameKey, java.lang.String descriptionKey, JobSet.ExecutionMode mode, ParameterList parameters, JobSetStep[] steps, java.lang.String firstStep, java.lang.String[] resourceBundleIDs)
name
- name of the JobSet definition to be created. The name is also used as the default display name unless otherwise specifially set.displayNameKey
- the key of the entry in the resourcebundles to lookup the name. Optional.descriptionKey
- the key of the entry in the resourcebundles to lookup the description. Optional.mode
- flag to indicate execution mode, true must be passed for a serial JobSet, false for parallel JobSet.parameters
- Parameters declared at the JobSet level.steps
- array of JobSetStep objects that represent the steps for this jobset.firstStep
- unique identifier of the step where execution begins for a serial jobset. This parameter is ignored for a parallel jobset.resourceBundleIDs
- an array of resource bundle id. OptionalMethod Detail |
---|
public JobSet.ExecutionMode getExecutionMode()
public void setExecutionMode(JobSet.ExecutionMode mode)
mode
- execution mode to be set (serial or parallel).public ParameterList getParameters()
public void setParameters(ParameterList params)
params
- instance of ParameterList containing all the parameters.
@Deprecated
public org.w3c.dom.Document getSteps()
getJsSteps()
.public void setFirstStep(java.lang.String firstStep)
Note that the first step is ignored for a parallel JobSet.
firstStep
- unique step id where serial JobSet execution starts.public java.lang.String getFirstStep()
Note that the first step is ignored for a parallel JobSet.
@Deprecated
public void setSteps(org.w3c.dom.Document doc,
java.lang.String firstStep)
setJsSteps(JobSetStep[])
.doc
- the XML fragment containing the details of JobSet.firstStep
- the valid step Id from within the XML fragment that indicates the first step. Required only for a Serial JobSet. For parallel JobSet, it can be null.public void addStep(JobSetStep step) throws ValidationException
step
- the step to add.ValidationException
- if the step id already exists in this JobSet.public JobSetStep getStep(java.lang.String stepId)
stepId
- the id of the step to get.JobSetStep
or null if the step does not exist.public JobSetStep deleteStep(java.lang.String stepId)
stepId
- the id of the step to delete.public java.util.HashMap<java.lang.String,JobSetStep> getAllSteps() throws MetadataNotFoundException, MetadataServiceException
HashMap
that contains all of the steps in this JobSet
and all steps in any JobSet
that is nested in this JobSet
.HashMap
that maps fully qualified stepId (sequence of step names delimited with STEPID_DELIMITER) to JobSetStep
and includes all steps in this JobSet
and any nested jobsets.MetadataNotFoundException
- if any nested JobSet definition does not exist.MetadataServiceException
- if the metadata subsystem encounters an error.
@Deprecated
public java.util.HashMap<java.lang.String,JobSetStep> getJobSetSteps()
getJsSteps()
HashMap
that contains the steps in this JobSet
. Note that order is not defined for the steps and may be different on a subsequent call.
Note that steps in nested jobsets are not included. To include all nested steps, use getAllSteps()
.
HashMap
that maps stepId to JobSetStep
.public java.util.List<JobSetStep> getJsSteps()
List
that contains the steps in this JobSet
. The steps are returned in the order that they were added to this jobset.
Note that steps in nested jobsets are not included. To include all nested steps, use getAllSteps()
.
List
of steps in this JobSetStep
.setJsSteps(JobSetStep[])
public void setJsSteps(JobSetStep[] steps) throws ValidationException
setFirstStep
.steps
- array of JobSetStep
objects to set as the steps for this jobset.ValidationException
- if the step ids are not unique.getJsSteps()
@Deprecated
public void setJobSetSteps(JobSetStep[] steps)
setJsSteps(JobSetStep[])
.steps
- array of JobSetStep
objects to set as the steps for this jobset.protected void validateCustom() throws ValidationException
The method does not validate the actual existence of the JobDefinition or other JobSet definitions referenced by this JobSet in its steps. Such validations are performed when the JobSet is persisted via the MetadataService
.
validateCustom
in class BaseMetadata<JobSet>
ValidationException
- if any validation errors occur.public void validateForExecution() throws ValidationException
ValidationException
- if any validation errors occur.public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
obj
- object to compare with this JobSet.public java.lang.String toDebugString()
public static javax.management.openmbean.CompositeType toCompositeType()
public javax.management.openmbean.CompositeData toCompositeData(javax.management.openmbean.CompositeType ct)
toCompositeData
in class BaseMetadata<JobSet>
public static JobSet from(javax.management.openmbean.CompositeData cd) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
protected JobSet getSelf()
getSelf
in class BaseMetadata<JobSet>
public BaseMetadataType<JobSet> getBaseMetadataType()
getBaseMetadataType
in class BaseMetadata<JobSet>
public JobSet clone(java.lang.String newName) throws ValidationException
clone
in class BaseMetadata<JobSet>
ValidationException
|
Oracle Enterprise Scheduler Java API Reference 11g Release 1 (11.1.1.7) E26229-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |