Package oracle.as.scheduler

Class Workshift

java.lang.Object
oracle.as.scheduler.BaseMetadata<Workshift>
oracle.as.scheduler.Workshift
All Implemented Interfaces:
Serializable
public class Workshift extends BaseMetadata<Workshift> implements Serializable
This class defines a workshift for a Request Processor. A workshift indicates the operating (active) times for a Request Processor.

Workshift is used for two main features with respect to a Request Processor.

  • Work assignments can be attached to a Request Processor on a per Workshift basis.
  • Resources of a Request Processor can be controlled on a per Workshift basis.

The combination of the above two features gives the ability to exactly define what kind of requests a processor should process (work assignment) and how much resources should be given for processing.

Finally multiple work assignments (each having a work shift) can be associated to a Request Processor to control and vary the kind of work that can be processed and the resources for it.

For example a work assignment can have 2 workshifts, dayshift and nightshift. Here the daytime workshift can have more resources for peak time while the nightshift can have very few.

Workshifts are always associated with a work assignment first and the work assignment is then bound to a Request Processor.

See Also:

  • Field Details

    • NO_LIMIT

      public static final int NO_LIMIT
      Constant that indicates no async limit is set.
      See Also:

  • Constructor Details

    • Workshift

      public Workshift(String name, String description, MetadataObjectId schedule, int duration, int allocation)
      Creates a Workshift definition with no async limits.
      Parameters:
      name - name of the Workshift.
      description - optional description.
      schedule - name of a Schedule definition.
      duration - duration in minutes that the workshift is active for each date in the schedule.
      allocation - allocation weighting factor for resources.

    • Workshift

      public Workshift(String name, String description, MetadataObjectId schedule, int duration, int allocation, int plsqlLimit, int asyncJavaLimit)
      Creates a fully-defined Workshift definition.
      Parameters:
      name - name of the Workshift.
      description - optional description.
      schedule - name of a Schedule definition.
      duration - duration in minutes that the workshift is active for each date in the schedule.
      allocation - allocation weighting factor for resources.
      plsqlLimit - global limit of PL/SQL jobs running in this workshift.
      asyncJavaLimit - global limit of asyncJava jobs running in this workshift.

    • Workshift

      public Workshift(String name, String displayNameKey, String descriptionKey, MetadataObjectId schedule, int duration, int allocation, String[] resourceBundleIDs)
      Creates a Workshift definition with no async limits and with associated resource bundles.
      Parameters:
      name - workshift name. The name is also used as the default display name unless otherwise specifically set.
      displayNameKey - resource bundle key for the display name. Optional.
      descriptionKey - resource bundle key for the description. Optional.
      schedule - name of a Schedule definition.
      duration - duration in minutes that the workshift is active for each date in the schedule.
      allocation - allocation weighting factor for resources.
      resourceBundleIDs - array of resource bundle ids. Optional.

    • Workshift

      public Workshift(String name, String displayNameKey, String descriptionKey, MetadataObjectId schedule, int duration, int allocation, int plsqlLimit, int asyncJavaLimit, String[] resourceBundleIDs)
      Creates a fully-defined Workshift definition and associated resource bundles.
      Parameters:
      name - workshift name. The name is also used as the default display name unless otherwise specifically set.
      displayNameKey - resource bundle key for the display name. Optional.
      descriptionKey - resource bundle key for the description. Optional.
      schedule - name of a Schedule definition.
      duration - duration in minutes that the workshift is active for each date in the schedule.
      allocation - allocation weighting factor for resources.
      plsqlLimit - global limit of PL/SQL jobs running in this workshift.
      asyncJavaLimit - global limit of asyncJava jobs running in this workshift.
      resourceBundleIDs - array of resource bundle ids. Optional.

  • Method Details

    • getAllocation

      public int getAllocation()
      Gets the allocation weighting factor for this Workshift.
      Returns:
      allocation weighting factor of this Workshift.

    • setAllocation

      public void setAllocation(int allocation)
      Sets the allocation weighting factor for this Workshift.
      Parameters:
      allocation - weighting factor of this Workshift.

    • getPlsqlLimit

      public int getPlsqlLimit()
      Gets the maximum number of PL/SQL jobs that can be running concurrently for this (Workshift, IsolationGroup).
      Returns:
      PL/SQL job limit.

    • setPlsqlLimit

      public void setPlsqlLimit(int plsqlLimit)
      Sets the maximum number of PL/SQL jobs that can be running concurrently for this (Workshift, IsolationGroup).
      Parameters:
      plsqlLimit - concurrent PL/SQL jobs.

    • getAsyncJavaLimit

      public int getAsyncJavaLimit()
      Gets the maximum number of asyncJava jobs that can be running concurrently for this (Workshift, IsolationGroup).
      Returns:
      asyncJava job limit.

    • setAsyncJavaLimit

      public void setAsyncJavaLimit(int asyncJavaLimit)
      Sets the max number of asyncJava jobs that can be running concurrently for this (Workshift, IsolationGroup).
      Parameters:
      asyncJavaLimit - concurrent asyncJava jobs.

    • getSchedule

      public MetadataObjectId getSchedule()
      Gets the MetadataObjectId for the Schedule associated with this workshift.

      To retrieve the Schedule definition itself, call the MetadataService.geSchedule API and pass the name returned by this method.

      Returns:
      metadata object id of Schedule definition, or null if no schedule is specified.

    • setSchedule

      public void setSchedule(MetadataObjectId schedule)
      Sets the Schedule for this Workshift.

      When this Workshift is added to the system via the call to MetadataService.addWorkshift, the metadata service will verify that a Schedule definition referred by the name given in this method exists in the metadata repository.

      Parameters:
      schedule - identifier of the Schedule definition.

    • getDuration

      public int getDuration()
      The duration, in minutes, of this Workshift.
      Returns:
      duration in minutes.

    • setDuration

      public void setDuration(int duration)
      Sets the duration.
      Parameters:
      duration - duration in minutes.

    • equals

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

    • toString

      public String toString()
      Description copied from class: BaseMetadata
      Same value as BaseMetadata.getName().
      Overrides:
      toString in class BaseMetadata<Workshift>
      Returns:
      the string represtation of this object.

    • getBaseMetadataType

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

    • clone

      public Workshift clone(String newName)
      Specified by:
      clone in class BaseMetadata<Workshift>