Package oracle.as.scheduler

Class ParameterInfo

java.lang.Object
oracle.as.scheduler.ParameterInfo
All Implemented Interfaces:
Serializable, Cloneable
public class ParameterInfo extends Object implements Cloneable, Serializable
Defines the metadata (information) of a parameter. This class should be used to declare parameters for a JobDefinition, JobType or JobSet definition.
See Also:

  • Constructor Details

    • ParameterInfo

      public ParameterInfo(ParameterInfo source)
      Constructs a new instance with the same information as the specified object.
      Parameters:
      source - the object whose attribtes are to be copied.
      Throws:
      NullPointerException - if the specified object is null.

    • ParameterInfo

      public ParameterInfo(String name, ParameterInfo.DataType type)
      Constructs a new instance. The associated value will be set to null and the read-only and legacy attributes will be set to false.
      Parameters:
      name - the name of the parameter.
      type - the data type as one of the supported enum.

    • ParameterInfo

      public ParameterInfo(String name, ParameterInfo.DataType type, boolean legacy)
      Constructs a new instance. The associated value will be set to null and the legacy attribute will be set to false.
      Parameters:
      name - the name of the parameter.
      type - the data type as one of the supported enum.
      legacy - indicates whether the parameter is legacy or not.

    • ParameterInfo

      public ParameterInfo(String name, ParameterInfo.DataType type, Object value, boolean readOnly)
      Constructs a new instance. The instance is for a non-legacy parameter.
      Parameters:
      name - the name of the parameter.
      type - the data type as one of the supported enum.
      value - the (default) value for the parameter.
      readOnly - indicates whether the parameter is read-only or not.

    • ParameterInfo

      public ParameterInfo(String name, ParameterInfo.DataType type, Object value, boolean readOnly, boolean legacy)
      Constructs a new instance using the specified attributes.
      Parameters:
      name - the name of the parameter.
      type - the data type as one of the supported enum.
      value - the (default) value for the parameter.
      readOnly - indicates whether the parameter is read-only or not.
      legacy - indicates whether the parameter is legacy or not.

  • Method Details

    • clone

      public Object clone()
      Clone this object.

    • getName

      public String getName()
      The name of this parameter.
      Returns:
      the name of this parameter.

    • getDataType

      public ParameterInfo.DataType getDataType()
      The data type of this parameter.
      Returns:
      the data type of this object.

    • getValue

      public Object getValue()
      The value of this parameter.
      Returns:
      the value as an Object. The value can be type-cast to appropriate type by using the associated DataType or by using instanceof.

    • setValue

      public void setValue(Object value)
      Sets the value of this parameter. The type of the value must match the data type of this parameter.
      Parameters:
      value - the value to be set. This can be null.

    • isReadOnly

      public boolean isReadOnly()
      Checks if this parameter is read-only or not.

      If read-only, subsequent objects (such as job request) cannot change the value. Typically a read-only parameter will have a default value that cannot be changed by subsequent objects.

      Note that the value can be changed in the object itself where this parameter is defined. For example if this parameter is defined in a JobType as read only parameter, its value can be changed in the JobType definition itself, but a derived JobDefinition or a Job request cannot override the value.

      Returns:
      true if this parameter is declared as read-only, false otherwise.

    • setReadOnly

      public void setReadOnly(boolean readOnly)
      Sets the read-only attribute of this parameter.
      Parameters:
      readOnly - true to mark this parameter as read-only.

    • isLegacy

      public boolean isLegacy()
      Checks if this parameter is legacy or not. The legacy flag provides a way for a user-interface to differentiate normal ESS system properties from system properties that exist for legacy systems.
      Returns:
      true if this parameter is legacy, false otherwise.

    • setLegacy

      public void setLegacy(boolean legacy)
      Sets the legacy attribute of this parameter.
      Parameters:
      legacy - true to mark this parameter as legacy.

    • equals

      public boolean equals(Object obj)
      Compare the given object to this object for equality.
      Overrides:
      equals in class Object
      Parameters:
      obj - ParameterInfo object to compare.
      Returns:
      true of the given object is equal to this object, or false otherwise.