Package oracle.as.scheduler

Class WorkAssignment

java.lang.Object
oracle.as.scheduler.BaseMetadata<WorkAssignment>
oracle.as.scheduler.WorkAssignment
All Implemented Interfaces:
Serializable
public class WorkAssignment extends BaseMetadata<WorkAssignment> implements Serializable
This class defines the nature of the work (requests) that should be processed by a Request Processor. A WorkAssignment contains all the specialization rules and workshifts to define what kind of requests a Request Processor should process, when it should process and how much resources should be provided to a Request Processor.

The operating times and resource allocation for a WorkAssignment are defined via a Workshift definition. One or more Workshift definitions can be associated with the WorkAssignment definition.

Once a WorkAssignment is defined, it can then be associated with a Request Processor at runtime. A definition of a WorkAssignment can be bound to one or more Request Processors and a Request Processor can have multiple WorkAssignment definitions bound to it.

See Also:

  • Constructor Details

    • WorkAssignment

      public WorkAssignment(String name, String description)
      Constructor with the name and description.
      Parameters:
      name - name to be assigned to this WorkAssignment. Name is also used as the default display name unless otherwise specifically set.
      description - description for this WorkAssignment, or null if none.

    • WorkAssignment

      public WorkAssignment(String name, String displayNameKey, String descriptionKey, String[] resourceBundleIDs)
      Constructor with the name and description and associated resource bundles.
      Parameters:
      name - name of the WorkAssignment. 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.
      resourceBundleIDs - optional array of resource bundle id.

    • WorkAssignment

      public WorkAssignment(String name, String description, Document specialization, Collection<MetadataObjectId> workshifts, boolean active)
      Constructor to create a fully-defined WorkAssignment.
      Parameters:
      name - name of the WorkAssignment. Name is also used as the default display name unless otherwise specifically set.
      description - the description for this WorkAssignment, or null if none.
      specialization - XML fragment that defines the specialization rules for this WorkAssignment.
      workshifts - collection of the names of one or more Workshift definitions to be associated with this WorkAssignment.
      active - true if the work assignment is active; false if it is not active.

    • WorkAssignment

      public WorkAssignment(String name, String displayNameKey, String descriptionKey, Document specialization, Collection<MetadataObjectId> workshifts, boolean active, String[] resourceBundleIDs)
      Constructor to create a fully-defined WorkAssignment and associated resource bundles.
      Parameters:
      name - name of the WorkAssignment. 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.
      specialization - the XML fragment that defines the specialization rules for this WorkAssignment.
      workshifts - a collection of the names of one or more Workshift definitions to be associated with this WorkAssignment.
      active - true if the work assignment is active; false if it is not active.
      resourceBundleIDs - optional array of resource bundle id.

  • Method Details

    • addWorkshifts

      public void addWorkshifts(Collection<MetadataObjectId> objectIds)
      Adds a collection of workshifts to this WorkAssignment. The workshifts are identified by their metadata object identifiers.

      When this WorkAssignment definition is persisted in the metadata repository using the metadata services, the metadata service validates that the workshifts referred by the names in the argument exist in the system.

      Parameters:
      objectIds - list of workshifts to be associated to this WorkAssignment.

    • addWorkshift

      public void addWorkshift(MetadataObjectId objectId)
      Adds a workshift to this WorkAssignment. The workshift is appended to list of workshifts already associated with this WorkAssignment.

      When this WorkAssignment definition is persisted in the metadata repository using the metadata services, the metadata service validates that the workshift referred by the name in the argument exist in the system.

      Parameters:
      objectId - identifier of a workshift to be associated with this WorkAssignment.

    • getWorkshifts

      public Collection<MetadataObjectId> getWorkshifts()
      Returns the workshifts that are associated with this WorkAssignment. The method returns the metadata identifer of the workshifts.

      The actual Workshift definitions can be retrieved by calling the appropriate methods in the metdata services.

      Returns:
      collection of the identifiers of the Workshifts associated with this WorkAssignment.

    • removeWorkshift

      public void removeWorkshift(MetadataObjectId objectId)
      Removes a workshift from this WorkAssignment.
      Parameters:
      objectId - identifier of the Workshift to be removed.

    • getSpecializationRules

      public Document getSpecializationRules()
      Retrieves the specialization rules defined in this WorkAssignment.
      Returns:
      specialization rules in XML format.

    • setSpecializationRules

      public void setSpecializationRules(Document doc)
      Sets the specialization rules for this WorkAssignment.

      These rules are specified as an XML fragment that must comply with the specified XML schema. The enforcement and validation of the XML fragment against the schema is done when the WorkAssignment is persisted using the metadata services.

      Parameters:
      doc - XML fragment that contains the specialization rule.

    • isEnabled

      public boolean isEnabled()
      Checks if the work assignment definition is enabled.
      Returns:
      true if enabled, or {code false} is disabled.

    • setEnabled

      public void setEnabled(boolean value)
      Enables or disables the work assignment.
      Parameters:
      value - true to enable; false to disable.

    • isActive

      @Deprecated public boolean isActive()
      Deprecated.
      Replaced by isEnabled()
      Checks if the work assignment definition is enabled or not.
      Returns:
      true if enabled, or {code false} otherwise.

    • setActive

      @Deprecated public void setActive(boolean value)
      Deprecated.
      Replaced by setEnabled(boolean)
      Enables or disables the work assignment.
      Parameters:
      value - true to enable, false to disable.

    • validateBound

      public void validateBound() throws ValidationException
      Validates this as a bound WorkAssignment. The validation for a bound WorkAssignment is more stringent than for a non-bound one. This method also performs the basic validation.

      The method performs checks that are possible on this object. It does not ensure the existence of objects referenced by this definition. Such references and related validations are done by the MetadataService at the time of object persistence.

      MetadataService also calls this method to ensure only valid objects are persisted.

      Throws:
      ValidationException - thrown if any invalid data is detected.

    • validateBound

      public void validateBound(Locale clientLocale) throws ValidationException
      Validates this as a bound WorkAssignment. The validation for a bound WorkAssignment is more stringent than for a non-bound one. This method also performs the basic validation.

      The method performs checks that are possible on this object. It does not ensure the existence of objects referenced by this definition. Such references and related validations are done by the MetadataService at the time of object persistence.

      MetadataService also calls this method to ensure only valid objects are persisted.

      Throws:
      ValidationException - thrown if any invalid data is detected.

    • equals

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

    • toString

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

    • getBaseMetadataType

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

    • clone

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