Package oracle.as.scheduler

Class JobSet

java.lang.Object
oracle.as.scheduler.BaseMetadata<JobSet>
oracle.as.scheduler.JobSet
All Implemented Interfaces:
Serializable
public class JobSet extends BaseMetadata<JobSet> implements Serializable
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.

See Also:

  • Field Details

  • Constructor Details

    • JobSet

      public JobSet(String name, String description, JobSet.ExecutionMode mode)
      Constructs a JobSet with basic attributes.
      Parameters:
      name - name of the JobSet definition to be created. The name is also used as the default display name unless otherwise specifically set.
      description - optional description for the JobSet definition. A null value is acceptable.
      mode - true for serial JobSet, false for parallel JobSet.

    • JobSet

      public JobSet(String name, String displayNameKey, String descriptionKey, JobSet.ExecutionMode mode, String[] resourceBundleIDs)
      Constructs a JobSet with basic attributes.
      Parameters:
      name - name of the JobSet definition to be created. The name is also used as the default display name unless otherwise specifically set.
      displayNameKey - the resource bundle key for the display name. Optional.
      descriptionKey - the resource bundle key for the description. Optional.
      mode - true for serial JobSet, false for parallel JobSet.
      resourceBundleIDs - an array of resource bundle id. Optional.

    • JobSet

      public JobSet(String name, String description, JobSet.ExecutionMode mode, MetadataObjectId objectId)
      Constructs a JobSet.

      Internal Use Only.

      This constructor is for internal use ONLY and should not be used to construct a new instance. This constructor is used internally by the MetadataService to populate the unique identifier of this object(definition) within the metadata repository.

      Parameters:
      name - name of the JobSet definition to be created. The name is also used as the default display name unless otherwise specifically 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. exclude from javadoc

    • JobSet

      public JobSet(String name, String displayName, String description, JobSet.ExecutionMode mode, MetadataObjectId objectId)
      Constructs a JobSet.

      Internal Use Only.

      This constructor is for internal use ONLY and should not be used to construct a new instance. This constructor is used internally by the MetadataService to populate the unique identifier of this object(definition) within the metadata repository.

      Parameters:
      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. exclude from javadoc

    • JobSet

      public JobSet(String name, String description, JobSet.ExecutionMode mode, ParameterList parameters, JobSetStep[] steps)
      Constructs a nearly fully defined JobSet. If the JobSet is serial, the first step must be set by calling setFirstStep.
      Parameters:
      name - name for the JobSet definition to be created. The name is also used as the default display name unless otherwise specifically set.
      description - optional description field for the JobSet.
      mode - indicates the execution mode, true for 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.

    • JobSet

      public JobSet(String name, String displayNameKey, String descriptionKey, JobSet.ExecutionMode mode, ParameterList parameters, JobSetStep[] steps, String[] resourceBundleIDs)
      Constructs a nearly fully defined JobSet. If the JobSet is serial, the first step must be set by calling setFirstStep.
      Parameters:
      name - name of the JobSet definition to be created. The name is also used as the default display name unless otherwise specifically set.
      displayNameKey - the resource bundle key for the display name. Optional.
      descriptionKey - the resource bundle key for the description. Optional.
      mode - indicates the execution mode, true for 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.

    • JobSet

      public JobSet(String name, String description, JobSet.ExecutionMode mode, ParameterList parameters, JobSetStep[] steps, String firstStep)
      Constructs a fully defined JobSet.
      Parameters:
      name - name for the JobSet definition to be created. The name is also used as the default display name unless otherwise specifically set.
      description - optional description field for the JobSet.
      mode - indicates the execution mode, true for 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.

    • JobSet

      public JobSet(String name, String displayNameKey, String descriptionKey, JobSet.ExecutionMode mode, ParameterList parameters, JobSetStep[] steps, String firstStep, String[] resourceBundleIDs)
      Constructs a fully defined JobSet and associate the JobSet definition with a set of resource bundles.

      Parameters:
      name - name of the JobSet definition to be created. The name is also used as the default display name unless otherwise specifically set.
      displayNameKey - the resource bundle key for the display name. Optional.
      descriptionKey - the resource bundle key for the description. Optional.
      mode - indicates the execution mode; true for serial JobSet, or 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. Optional

  • Method Details

    • getExecutionMode

      public JobSet.ExecutionMode getExecutionMode()
      Checks whether this JobSet is a serial or a parallel JobSet.
      Returns:
      execution mode of this JobSet (serial or parallel)

    • setExecutionMode

      public void setExecutionMode(JobSet.ExecutionMode mode)
      Sets the JobSet execution mode to either serial or parallel mode.
      Parameters:
      mode - execution mode to be set (serial or parallel).

    • getParameters

      public ParameterList getParameters()
      Returns all the parameters defined for this JobSet
      Returns:
      instance of ParameterList containing all the parameters.

    • setParameters

      public void setParameters(ParameterList params)
      Sets the parameters of this JobSet.
      Parameters:
      params - instance of ParameterList containing all the parameters.

    • getSteps

      @Deprecated public Document getSteps()
      Deprecated.
      Replaced by getJsSteps().
      Retrieves the details of all the steps in this JobSet definition. The details are returned in the form of XML fragment that comply with the corresponding XML Schema.
      Returns:
      XML fragment containing steps of this JobSet.

    • setFirstStep

      public void setFirstStep(String firstStep)
      Sets the unique id of the first step to run for a serial JobSet.

      Note that the first step is ignored for a parallel JobSet.

      Parameters:
      firstStep - unique step id where serial JobSet execution starts.

    • getFirstStep

      public String getFirstStep()
      Returns the id of the first or starting step in a serial JobSet.

      Note that the first step is ignored for a parallel JobSet.

      Returns:
      step Id of the first (starting) step for a serial jobset.

    • setSteps

      @Deprecated public void setSteps(Document doc, String firstStep)
      Deprecated.
      Replaced by setJsSteps(JobSetStep[]).
      Sets the steps and the details of the steps for this JobSet. All details should be specified in an XML fragment that comply with the corresponding XML schema.
      Parameters:
      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.

    • addStep

      public void addStep(JobSetStep step) throws ValidationException
      Adds the given step to this JobSet.
      Parameters:
      step - the step to add.
      Throws:
      ValidationException - if the step id already exists in this JobSet.

    • getStep

      public JobSetStep getStep(String stepId)
      Gets the JobSet step with the given step id.
      Parameters:
      stepId - the id of the step to get.
      Returns:
      requested JobSetStep, or null if the step does not exist.

    • deleteStep

      public JobSetStep deleteStep(String stepId)
      Deletes the JobSet step with the given step id.
      Parameters:
      stepId - the id of the step to delete.
      Returns:
      the deleted step or null if the step does not exist.

    • getAllSteps

      public HashMap<String,JobSetStep> getAllSteps() throws MetadataNotFoundException, MetadataServiceException
      Gets all steps of this JobSet and any nested Jobset. The returned HashMap contains all of the steps in this JobSet and all steps in any JobSet that is nested in this JobSet.
      Returns:
      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.
      Throws:
      MetadataNotFoundException - if any nested JobSet definition does not exist.
      MetadataServiceException - if the metadata subsystem encounters an error.

    • getJobSetSteps

      @Deprecated public HashMap<String,JobSetStep> getJobSetSteps()
      Deprecated.
      Replaced by getJsSteps()
      The returned HashMap contains the steps in this JobSet Note that order is not defined for the steps and may be different on a subsequent call.

      Steps in any nested jobsets are not included. To include all nested steps, use getAllSteps.

      Returns:
      HashMap that maps stepId to JobSetStep.

    • getJsSteps

      public List<JobSetStep> getJsSteps()
      Gets all jobset steps of this jobset. The returned List contains the steps in this JobSet. The steps are returned in the order that they were added to this jobset.

      Steps in nested jobsets are not included. To include all nested steps, use getAllSteps.

      Returns:
      an ordered List of steps in this JobSetStep.
      See Also:

    • setJsSteps

      public void setJsSteps(JobSetStep[] steps) throws ValidationException
      Sets the steps for this jobset to the given steps. Any steps already in the jobset will be replaced. If the JobSet is serial, the first step must be set after this by calling setFirstStep.
      Parameters:
      steps - array of JobSetStep objects to set as the steps for this jobset.
      Throws:
      ValidationException - if the step ids are not unique.
      See Also:

    • setJobSetSteps

      @Deprecated public void setJobSetSteps(JobSetStep[] steps)
      Deprecated.
      Replaced by setJsSteps(JobSetStep[]).
      Sets the steps for this jobset to the given steps. Any steps already in the jobset will be replaced.
      Parameters:
      steps - array of JobSetStep objects to set as the steps for this jobset.

    • validateForExecution

      public void validateForExecution() throws ValidationException
      Validates this JobSet for execution. Performs normal jobset validation and performs additional validation to ensure the jobset is valid for execution.
      Throws:
      ValidationException - if any validation errors occur.

    • equals

      public boolean equals(Object obj)
      Compares an object for equality with this JobSet object.
      Overrides:
      equals in class Object
      Parameters:
      obj - object to compare with this JobSet.
      Returns:
      true if the object passed in is an instance of JobSet and is equal to this JobSet, false otherwise.

    • compareWithParams

      public int compareWithParams(Object obj)
      Compares an object for equality with this JobSet object.
      Parameters:
      obj - object to compare.
      Returns:
      0 if the objects are equal; -1 if only customizable params differ (but the same cust params must be in both objs); 1 if there are other differences, including any missing param.

    • toDebugString

      public String toDebugString()
      A debug string representation for this JobSet object.
      Returns:
      String representation of this JobSet. exclude from javadoc

    • toCompositeType

      public static CompositeType toCompositeType()
      Returns the CompositeType that describes this model specific class exclude from javadoc

    • toCompositeData

      public CompositeData toCompositeData(CompositeType ct)
      exclude from javadoc

    • from

      public static JobSet from(CompositeData cd) throws IllegalArgumentException
      Create an instance of the model specific class out of an associated CompositeData instance exclude from javadoc
      Throws:
      IllegalArgumentException

    • getBaseMetadataType

      public BaseMetadataType<JobSet> getBaseMetadataType()
      Description copied from class: BaseMetadata
      Gets the intended type of this metadata.
      Specified by:
      getBaseMetadataType in class BaseMetadata<JobSet>
      Returns:
      the base metadata type

    • clone

      public JobSet clone(String newName) throws ValidationException
      Specified by:
      clone in class BaseMetadata<JobSet>
      Throws:
      ValidationException