|
Oracle Fusion Applications Java API Reference for Oracle Enterprise Scheduler Service 11g Release 1 (11.1.1.6) E20742-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.as.scheduler.ParameterInfo
public class ParameterInfo
Defines the metadata (information) of a parameter. This class should be used to declare parameters for a JobDefinition, JobType or JobSet definition.
Nested Class Summary | |
---|---|
static class |
ParameterInfo.DataType
Enumeration of supported data types. |
Constructor Summary | |
---|---|
ParameterInfo(ParameterInfo source)
Constructs a new instance with the same information as the specified object. |
|
ParameterInfo(java.lang.String name,
ParameterInfo.DataType type)
Constructs a new instance. |
|
ParameterInfo(java.lang.String name,
ParameterInfo.DataType type,
boolean legacy)
Constructs a new instance. |
|
ParameterInfo(java.lang.String name,
ParameterInfo.DataType type,
java.lang.Object value,
boolean readOnly)
Constructs a new instance. |
|
ParameterInfo(java.lang.String name,
ParameterInfo.DataType type,
java.lang.Object value,
boolean readOnly,
boolean legacy)
Constructs a new instance using the specified attributes. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Clone this object. |
boolean |
equals(java.lang.Object obj)
Compare the given object to this object for equality. |
ParameterInfo.DataType |
getDataType()
Returns the data type of this parameter. |
java.lang.String |
getName()
Returns the name of this parameter. |
java.lang.Object |
getValue()
Returns the value of this parameter. |
boolean |
isLegacy()
Checks if this parameter is legacy or not. |
boolean |
isReadOnly()
Checks if this parameter is read-only or not. |
void |
setLegacy(boolean legacy)
Sets the legacy attribute of this parameter. |
void |
setReadOnly(boolean readOnly)
Sets the read-only attribute of this parameter. |
void |
setValue(java.lang.Object value)
Sets the value of this parameter. |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ParameterInfo(ParameterInfo source)
source
- the object whose attribtes are to be copied.
java.lang.NullPointerException
- if the specified object is null
.public ParameterInfo(java.lang.String name, ParameterInfo.DataType type)
null
and the
read-only and legacy attributes will be set to false
.
name
- the name of the parameter.type
- the data type as one of the supported enum.public ParameterInfo(java.lang.String name, ParameterInfo.DataType type, boolean legacy)
null
and the
legacy attribute will be set to false
.
name
- the name of the parameter.type
- the data type as one of the supported enum.legacy
- whether the parameter is legacy or not.public ParameterInfo(java.lang.String name, ParameterInfo.DataType type, java.lang.Object value, boolean readOnly)
name
- the name of the parameter.type
- the data type as one of the supported enum.value
- the (default) value for the parameter.readOnly
- whether the parameter is read-only or not.public ParameterInfo(java.lang.String name, ParameterInfo.DataType type, java.lang.Object value, boolean readOnly, boolean legacy)
name
- the name of the parameter.type
- the data type as one of the supported enum.value
- the (default) value for the parameter.readOnly
- whether the parameter is read-only or not.legacy
- whether the parameter is legacy or not.Method Detail |
---|
public java.lang.Object clone()
clone
in class java.lang.Object
public java.lang.String getName()
public ParameterInfo.DataType getDataType()
public java.lang.Object getValue()
DataType
or by
using instanceof
.public void setValue(java.lang.Object value)
value
- the value to be set. This can be null
.public boolean isReadOnly()
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.
true
if this parameter is declared as read-only,
false
otherwise.public void setReadOnly(boolean readOnly)
readOnly
- true
to mark this parameter as read-only.public boolean isLegacy()
true
if this parameter is legacy,
false
otherwise.public void setLegacy(boolean legacy)
legacy
- true
to mark this parameter as legacy.public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
obj
- ParameterInfo
object to compare.
true
of the given object is equal to this
object, or false
otherwise.
|
Oracle Fusion Applications Java API Reference for Oracle Enterprise Scheduler Service 11g Release 1 (11.1.1.6) E20742-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |