Package oracle.as.scheduler

Class JobDefinition

java.lang.Object

oracle.as.scheduler.BaseMetadata<JobDefinition>

oracle.as.scheduler.JobDefinition

All Implemented Interfaces:

Serializable

public class JobDefinition
extends BaseMetadata<JobDefinition>
implements Serializable

Represents the definition (metadata) for a Job that runs in the Scheduler. A Job is the basic unit of work that runs in Scheduler. Every JobDefinition belongs to one and only one type of Job as indicated by its JobType definition.

The name of a JobDefinition is unique in the metadata repository. Once a JobDefinition is created with a given type, its name and JobType cannot be changed.

See Also:

• JobType
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
JobDefinition(String name, MetadataObjectId jobType)	Constructs a skeletal JobDefinition with name and JobType.
JobDefinition(String name, MetadataObjectId jobType, String displayNameKey, String descriptionKey, ParameterList parameters, String[] resourceBundleIDs)	Constructs a fully populated JobDefinition.
JobDefinition(String name, MetadataObjectId jobType, String description, ParameterList parameters)	Constructs a JobDefinition with the given parameters.

Method Summary

Modifier and Type	Method	Description
JobDefinition	clone(String newName)
int	compareWithParams(Object obj)	Compares an object for equality with this JobDefinition object.
boolean	equals(Object obj)	Compares an object for equality with this JobDefinition object.
BaseMetadataType<JobDefinition>	getBaseMetadataType()	Gets the intended type of this metadata.
MetadataObjectId	getJobType()	The metadata identifier of the JobType associated with this JobDefinition instance.
ParameterList	getParameters()	The parameters defined for this JobDefinition.
void	setParameters(ParameterList params)	Sets the parameters for this JobDefinition.
void	validate(JobType jobType)	Validates this JobDefinition.

Methods inherited from class oracle.as.scheduler.BaseMetadata

getDescription, getDescriptionKey, getDisplayName, getDisplayNameKey, getMetadataObjectId, getName, getResourceBundles, hashCode, setDescription, setDescriptionKey, setDisplayName, setDisplayNameKey, setResourceBundles, toString, validate

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

JobDefinition

public JobDefinition(String name,
 MetadataObjectId jobType)

Constructs a skeletal JobDefinition with name and JobType. Other appropriate methods must then be called to populate the definition.

Parameters:

name - the name for the JobDefinition. The name is also used as the default display name unless otherwise specifically set.

jobType - the identifier for the JobType definition for this JobDefinition object.

JobDefinition

public JobDefinition(String name,
 MetadataObjectId jobType,
 String description,
 ParameterList parameters)

Constructs a JobDefinition with the given parameters.

Parameters:

name - the name for the JobDefinition. The name is also used as the default display name unless otherwise specifically set.

jobType - the JobType for this JobDefinition.

description - an optional description to be associated.

parameters - all the parameters defined for this JobDefinition.

JobDefinition

public JobDefinition(String name,
 MetadataObjectId jobType,
 String displayNameKey,
 String descriptionKey,
 ParameterList parameters,
 String[] resourceBundleIDs)

Constructs a fully populated JobDefinition.

Parameters:

name - the name for the JobDefinition. The name is also used as the default display name unless otherwise specifically set.

jobType - the JobType for this JobDefinition.

displayNameKey - the resource bundle key for the display name. Optional.

descriptionKey - the resource bundle key for the description. Optional.

parameters - all the parameters defined for this JobDefinition.

resourceBundleIDs - an array of resource bundle id. Optional.

Method Details

getJobType

public MetadataObjectId getJobType()

The metadata identifier of the JobType associated with this JobDefinition instance.

Returns:

the metadata identifier of the JobType.

getParameters

public ParameterList getParameters()

The parameters defined for this JobDefinition.

Returns:

a ParameterList containing all the parameters.

setParameters

public void setParameters(ParameterList params)

Sets the parameters for this JobDefinition.

Parameters:

params - a ParameterList containing the parameters.

validate

public void validate(JobType jobType)
              throws ValidationException

Validates this JobDefinition.

Parameters:

jobType - the JobType to use for validation. This should represent the same JobType associated with this JobDefinition.

Throws:

ValidationException - if validation fails.

equals

public boolean equals(Object obj)

Compares an object for equality with this JobDefinition object.

Overrides:

equals in class Object

Parameters:

obj - the object to compare with this JobDefinition.

Returns:

true if obj passed is an instanceof JobDefinition and is equal to this JobDefinition, or false otherwise.

compareWithParams

public int compareWithParams(Object obj)

Compares an object for equality with this JobDefinition object.

Parameters:

obj - object to compare.

Returns:

result of the comparison

• 0 if the objects are equal
• -1 if only customizable params differ (but the same customizable params must be in both objs)
• 1 if there are other differences, including any missing param.

getBaseMetadataType

public BaseMetadataType<JobDefinition> getBaseMetadataType()

Description copied from class: BaseMetadata

Gets the intended type of this metadata.

Specified by:

getBaseMetadataType in class BaseMetadata<JobDefinition>

Returns:

the base metadata type

clone

public JobDefinition clone(String newName)

Specified by:

clone in class BaseMetadata<JobDefinition>