oracle.as.scheduler

Class JobSetStep

java.lang.Object

oracle.as.scheduler.JobSetStep

All Implemented Interfaces:

Serializable

public class JobSetStep
extends Object
implements Serializable

The JobSetStep class represents a step within a JobSet. A JobSetStep can be a JobDefinition or a nested JobSet.

This step is validated in the context of a JobSet by BaseMetadata.validate().

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JobSetStep.LinkType Link types for the links for a serial JobSetStep.

Constructor Summary

Constructors

Constructor and Description
JobSetStep(String stepId, MetadataObjectId jobId) Constructs a JobSetStep.
JobSetStep(String stepId, MetadataObjectId jobId, ParameterList stepParams) Constructs a JobSetStep.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Checks if the object is equal to this JobSetStep.
MetadataObjectId	getJobId() Gets the job id for this step.
String	getLink(JobSetStep.LinkType linkType) Gets the stepId for the given LinkType.
String	getStepId() Gets the stepId for this step.
ParameterList	getStepProps() The parameters and properties for this step.
void	setJobId(MetadataObjectId jobId) Sets the jobId for this step.
void	setLink(JobSetStep.LinkType linkType, String linkStepId) Defines a linked step for the given LinkType.
void	setStepProps(ParameterList stepParams) Sets the parameters and step properties for this step.
String	toString() String representation for this JobSetStep object.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JobSetStep

public JobSetStep(String stepId,
          MetadataObjectId jobId)

Constructs a JobSetStep.

Parameters:

stepId - a step id that is unique within the JobSet.

jobId - the MetadataObjectId of the JobDefinition or JobSet for this step.

JobSetStep

public JobSetStep(String stepId,
          MetadataObjectId jobId,
          ParameterList stepParams)

Constructs a JobSetStep.

Parameters:

stepId - a step id that is unique within the JobSet.

jobId - the MetadataObjectId of the JobDefinition or JobSet for this step.

stepParams - the step parameters and properties for this step.

Method Detail

setLink

public void setLink(JobSetStep.LinkType linkType,
           String linkStepId)

Defines a linked step for the given LinkType.

The given stepId will be run when this step completes with a state matching the link type.

Parameters:

linkType - the type of link to set.

linkStepId - the id of the step for the linkType.

getLink

public String getLink(JobSetStep.LinkType linkType)

Gets the stepId for the given LinkType.

Parameters:

linkType - the link type to get the step id for.

Returns:

step id for the link type.

getStepId

public String getStepId()

Gets the stepId for this step.

Returns:

the id of this step.

setJobId

public void setJobId(MetadataObjectId jobId)

Sets the jobId for this step.

Parameters:

jobId - the job id (JobDefinition or JobSet) for this step.

getJobId

public MetadataObjectId getJobId()

Gets the job id for this step.

Returns:

the job id (JobDefinition or JobSet) for this step.

setStepProps

public void setStepProps(ParameterList stepParams)

Sets the parameters and step properties for this step.

Parameters:

stepParams - the step parameters and properties for this step.

getStepProps

public ParameterList getStepProps()

The parameters and properties for this step.

Returns:

a ParameterList with parameters and properties for this step.

equals

public boolean equals(Object obj)

Checks if the object is equal to this JobSetStep.

Equal means it has the same stepId, same jobId, same linked step ids, and same step parameters and properties.

Overrides:

equals in class Object

Parameters:

obj - object to compare to this JobSetStep.

Returns:

true if the given object is a JobSetStep and it is equal to this JobSetStep; else false.

toString

public String toString()

String representation for this JobSetStep object.

Overrides:

toString in class Object

Returns:

a String representation of this JobSetStep.