oracle.as.scheduler

Class JobType

java.lang.Object

oracle.as.scheduler.BaseMetadata

oracle.as.scheduler.JobType

All Implemented Interfaces:

Serializable

public class JobType
extends BaseMetadata
implements Serializable

Encapsulates a JobType definition. A JobType is conceptually the highest level class among job metadata objects. It can be used to define the common characteristics for all the jobs that belong to a particular type.

This class represents all the metadata attributes for a JobType definition.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JobType.ExecutionType Enum of the basic execution types.

Constructor Summary

Constructors

Constructor and Description
JobType(String name, JobType.ExecutionType executionType) Constructor that creates a skeleton instance.
JobType(String name, String description, JobType.ExecutionType executionType, ParameterList parameters) Constructor to create a complete instance that can be used immediately upon creation.
JobType(String name, String displayNameKey, String descriptionKey, JobType.ExecutionType executionType, ParameterList parameters, String[] resourceBundleIDs) Constructor to create a complete instance that can be used immediately upon creation and associate the instance with a set of resource bundles.

Method Summary

Modifier and Type	Method and Description
JobType	clone(String newName)
int	compareWithParams(Object obj) Compares an object for equality with this JobType object.
boolean	equals(Object obj) Compares an object for equality with this JobType object.
BaseMetadataType	getBaseMetadataType() Gets the intended type of this metadata.
JobType.ExecutionType	getExecutionType() Gets the basic execution type of this JobType definition.
ParameterList	getParameters() Gets the parameters defined for this JobType definition.
void	setParameters(ParameterList params) Sets the parameters of this JobType definition.

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 Detail

JobType

public JobType(String name,
               JobType.ExecutionType executionType)

Constructor that creates a skeleton instance. The object data will need to be populated using other class methods.

Parameters:

name - the unique name for this JobType definition. The name is also used as the default display name unless otherwise specifically set.

executionType - the basic execution type of this JobType

JobType

public JobType(String name,
               String description,
               JobType.ExecutionType executionType,
               ParameterList parameters)

Constructor to create a complete instance that can be used immediately upon creation.

Parameters:

name - the unique name for this JobType definition. The name is also used as the default display name unless otherwise specifically set.

description - an optional description for this JobType

executionType - the basic execution type of this JobType

parameters - the parameters that describe the detailed attributes of this definition.

JobType

public JobType(String name,
               String displayNameKey,
               String descriptionKey,
               JobType.ExecutionType executionType,
               ParameterList parameters,
               String[] resourceBundleIDs)

Constructor to create a complete instance that can be used immediately upon creation and associate the instance with a set of resource bundles.

Parameters:

name - the unique name for this JobType definition. The 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.

executionType - the basic execution type of this JobType

parameters - the parameters that describe the detailed attributes of this definition.

resourceBundleIDs - an array of resource bundle ids.

Method Detail

getExecutionType

public JobType.ExecutionType getExecutionType()

Gets the basic execution type of this JobType definition.

Returns:

the execution type

getParameters

public ParameterList getParameters()

Gets the parameters defined for this JobType definition.

Returns:

the parameters associated with this definition

setParameters

public void setParameters(ParameterList params)

Sets the parameters of this JobType definition.

Parameters:

params - the parameters to be used for this definition

equals

public boolean equals(Object obj)

Compares an object for equality with this JobType object.

At present, the comparision checks the object is an instance of JobType and the execution type matches.

Overrides:

equals in class Object

Parameters:

obj - the object to compare

Returns:

true if the object is considered equal, or false if not

compareWithParams

public int compareWithParams(Object obj)

Compares an object for equality with this JobType object.

Parameters:

obj - object to compare.

Returns:

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

getBaseMetadataType

public BaseMetadataType getBaseMetadataType()

Description copied from class: BaseMetadata

Gets the intended type of this metadata.

Specified by:

getBaseMetadataType in class BaseMetadata

Returns:

the base metadata type

clone

public JobType clone(String newName)

Specified by:

clone in class BaseMetadata