Package oracle.as.scheduler

Class BaseMetadata<T extends BaseMetadata<T>>

java.lang.Object
oracle.as.scheduler.BaseMetadata<T>
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ExclusionsDefinition, Incompatibility, JobDefinition, JobSet, JobType, Schedule, WorkAssignment, Workshift
public abstract class BaseMetadata<T extends BaseMetadata<T>> extends Object implements Serializable
Base class for ESS metadata definitions.
See Also:

  • Method Details

    • getBaseMetadataType

      public abstract BaseMetadataType<T> getBaseMetadataType()
      Gets the intended type of this metadata.
      Returns:
      the base metadata type

    • clone

      public abstract T clone(String newName) throws ValidationException
      Throws:
      ValidationException

    • getName

      public final String getName()
      The name of this ESS metadata object.
      Returns:
      the name of this ESS metadata object.

    • getDisplayName

      public final String getDisplayName()
      Retrieves the user friendly name of this ESS metadata object.

      If this metadata displayName is associated with a key in the resource bundle, then the actual entry from the resource bundle will be located and returned.

      If the entry is not found in the resource bundle or there is no key associated, then the display name set on this instance is returned.

      Returns:
      the user friendly name of this ESS metadata object.

    • getDisplayNameKey

      public final String getDisplayNameKey()
      Retrieves the key to the entry in the associated resource bundle representing the display name.
      Returns:
      the key to the entry in the resource bundle.

    • getDescription

      public final String getDescription()
      Retrieves the description of this ESS metadata object.

      If this metadata description is associated with a key in the resource bundle, then the actual entry from the resource bundle will be located and returned.

      If the entry is not found in the resource bundle or there is no key associated, then the display name set on this instance is returned.

      Returns:
      the description of this ESS metadata object.

    • getDescriptionKey

      public final String getDescriptionKey()
      Retrieves the key to the entry in the associated resource bundle representing the description.
      Returns:
      the key to the entry in the resource bundle.

    • getResourceBundles

      public final String[] getResourceBundles()
      Retrieves the resource bundles associated with the translatable strings for this metadata.
      Returns:
      an array of resource bundles ids.

    • getMetadataObjectId

      public final MetadataObjectId getMetadataObjectId()
      Retrieves the unique identifier of this object within the metadata repository. This identifier is populated only by the MetadataService when this object is retrieved from the metadata repository. Therefore if an object is newly created to persist into the repository, it will not have the unique identifier set initially.
      Returns:
      the unique identifier associated with this object in the metadata repository. This will be null if this object is not obtained via the MetadataService APIs.

    • validate

      public final void validate() throws ValidationException
      Validates this metadata object.
      Throws:
      ValidationException - if validation fails.

    • setDisplayName

      public final void setDisplayName(String displayName)
      Sets the user friendly name associated with this ESS metadata object. This will be the default displayName if the resource bundle lookup is unsuccessful or no resource bundle is associated. A null value is acceptable and it has the effect of deleting existing display name text.
      Parameters:
      displayName - the user friendly name to be associated with this ESS metadata object.

    • setDisplayNameKey

      public final void setDisplayNameKey(String displayNameKey)
      Sets the key to be used for lookup display name in the associated resource bundles. A null value is acceptable and it has the effect of deleting existing key set for the displayName
      Parameters:
      displayNameKey - the key for the resource bundle entry representing the user friendly name to be associated with this ESS metadata object.

    • setDescription

      public final void setDescription(String description)
      Sets the description associated with this ESS metadata object. This will be the default description if the resource bundle lookup is unsuccessful or no resource bundle is associated. A null value is acceptable and it has the effect of deleting existing description text.
      Parameters:
      description - description to be associated with this ESS metadata object.

    • setDescriptionKey

      public final void setDescriptionKey(String descriptionKey)
      Sets the key to be used for lookup description in the associated resource bundles. A null value is acceptable and it has the effect of deleting the existing key.
      Parameters:
      descriptionKey - the entry to the resourcebundle representing the description to be associated with this ESS metadata object.

    • setResourceBundles

      public final void setResourceBundles(String[] resourceBundles)
      Sets the message bundles to be associated with the translatable strings.
      Parameters:
      resourceBundles - an array of resource bundle ids

    • toString

      public String toString()
      Same value as getName().
      Overrides:
      toString in class Object
      Returns:
      the string represtation of this object.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object