Skip navigation links

oracle.as.scheduler
Class JobType

java.lang.Object
oracle.as.scheduler.BaseMetadata<JobType>
oracle.as.scheduler.JobType

All Implemented Interfaces:

java.io.Serializable

public class JobType

extends BaseMetadata<JobType>

implements java.io.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

static class

JobType.ExecutionType Enum of the basic execution types.

Constructor Summary

JobType(java.lang.String name, JobType.ExecutionType executionType)
Constructor that creates a skeleton instance.

JobType(java.lang.String name, JobType.ExecutionType executionType, MetadataObjectId objectId)
Creates a new instance with the given name and execution type.

JobType(java.lang.String name, java.lang.String description, JobType.ExecutionType executionType, ParameterList parameters)
Constructor to create a complete instance that can be used immediately upon creation.

JobType(java.lang.String name, java.lang.String displayNameKey, java.lang.String descriptionKey, JobType.ExecutionType executionType, ParameterList parameters, java.lang.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

JobType	clone(java.lang.String newName)
boolean	equals(java.lang.Object obj) Compares an object for equality with this JobType object.
static JobType	from(javax.management.openmbean.CompositeData cd) Create an instance of the model specific class out of an associated CompositeData instance
BaseMetadataType<JobType>	getBaseMetadataType()
JobType.ExecutionType	getExecutionType() Gets the basic execution type of this JobType definition.
ParameterList	getParameters() Gets the parameters defined for this JobType definition.
protected JobType	getSelf()
void	setParameters(ParameterList params) Sets the parameters of this JobType definition.
javax.management.openmbean.CompositeData	toCompositeData(javax.management.openmbean.CompositeType ct)
static javax.management.openmbean.CompositeType	toCompositeType() Returns the CompositeType that describes this model specific class.
protected void	validateCustom() Performs validations on this object to ensure the associated data is valid.

Methods inherited from class oracle.as.scheduler.BaseMetadata

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JobType

public JobType(java.lang.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 specifially set.

executionType - the basic execution type of this JobType

JobType

public JobType(java.lang.String name,
               JobType.ExecutionType executionType,
               MetadataObjectId objectId)

Creates a new instance with the given name and execution type.

Internal use only

This constructor is for internal use ONLY and should not be used by client applications. This constructor is used internally by the MetadataService to populated the unique identifier of this JobType definition within the metadata repository.

Parameters:

name - - the unique name for this JobType definition It cannot be null. The name is also used as the default display name unless otherwise specifially set.

executionType - the basic execution type of this JobType

objectId - the unique identifier of this object in the metadata repository

JobType

public JobType(java.lang.String name,
               java.lang.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 specifially 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(java.lang.String name,
               java.lang.String displayNameKey,
               java.lang.String descriptionKey,
               JobType.ExecutionType executionType,
               ParameterList parameters,
               java.lang.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 specifially set.

displayNameKey - - the key of the entry in the resourcebundles to lookup the name. It cannot be null.

descriptionKey - - the key of the entry in the resourcebundles to lookup 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 id

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

validateCustom

protected void validateCustom()
                       throws ValidationException

Performs validations on this object to ensure the associated data is valid. This method can be called by a client application to verify that the definition data is valid.

This method is also called by the MetadataService before any JobType is persisted to ensure that only valid objects are stored in the metadata repository.

Specified by:

validateCustom in class BaseMetadata<JobType>

Throws:

ValidationException - if the validation fails.

equals

public boolean equals(java.lang.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 java.lang.Object

Parameters:

obj - the object to compare

Returns:

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

toCompositeType

public static javax.management.openmbean.CompositeType toCompositeType()

Returns the CompositeType that describes this model specific class.

toCompositeData

public javax.management.openmbean.CompositeData toCompositeData(javax.management.openmbean.CompositeType ct)

Specified by:

toCompositeData in class BaseMetadata<JobType>

from

public static JobType from(javax.management.openmbean.CompositeData cd)
                    throws java.lang.IllegalArgumentException

Create an instance of the model specific class out of an associated CompositeData instance

Throws:

java.lang.IllegalArgumentException

getSelf

protected JobType getSelf()

Specified by:

getSelf in class BaseMetadata<JobType>

getBaseMetadataType

public BaseMetadataType<JobType> getBaseMetadataType()

Specified by:

getBaseMetadataType in class BaseMetadata<JobType>

clone

public JobType clone(java.lang.String newName)

Specified by:

clone in class BaseMetadata<JobType>

Skip navigation links