Skip navigation links

Oracle Enterprise Scheduler Java API Reference
11g Release 1 (11.1.1.7)
E26229-06


oracle.as.scheduler
Class JobSetStep

java.lang.Object
  extended by oracle.as.scheduler.JobSetStep

All Implemented Interfaces:
java.io.Serializable

public class JobSetStep
extends java.lang.Object
implements java.io.Serializable

The JobSetStep class represents a step within a JobSet, for example, a JobDefinition or a nested JobSet. Note: This step is validated in the context of a JobSet by JobSet.validate().

See Also:
Serialized Form

Nested Class Summary
static class JobSetStep.LinkType
          Link types for the links for a serial JobSetStep.

 

Constructor Summary
JobSetStep(java.lang.String stepId, MetadataObjectId jobId)
          Constructs a JobSetStep.
JobSetStep(java.lang.String stepId, MetadataObjectId jobId, ParameterList stepParams)
          Constructs a JobSetStep.

 

Method Summary
 boolean equals(java.lang.Object obj)
          Checks if the object is equal to this JobSetStep.
 MetadataObjectId getJobId()
          Gets the job id for this step.
 java.lang.String getLink(JobSetStep.LinkType linkType)
          Returns the stepId for the given LinkType.
 java.lang.String getStepId()
          Gets the stepId for this step.
 ParameterList getStepProps()
          Returns the parameters and properties for this step.
 void setJobId(MetadataObjectId jobId)
          Sets the jobId for this step.
 void setLink(JobSetStep.LinkType linkType, java.lang.String linkStepId)
          Defines a linked step for the given LinkType.
 void setStepId(java.lang.String stepId)
          Deprecated. step id is immutable.
 void setStepProps(ParameterList stepParams)
          Sets the parameters and step properties for this step.
 java.lang.String toDebugString()
          Returns a debug String representation for this JobSetStep object.
 java.lang.String toString()
          Returns a String representation for this JobSetStep object.

 

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Constructor Detail

JobSetStep

public JobSetStep(java.lang.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(java.lang.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,
                    java.lang.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 java.lang.String getLink(JobSetStep.LinkType linkType)
Returns the stepId for the given LinkType.
Parameters:
linkType - the link type to get the step id for.
Returns:
step id for the link type.

setStepId

@Deprecated
public void setStepId(java.lang.String stepId)
Deprecated. step id is immutable.
Unsupported.

getStepId

public java.lang.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()
Returns the parameters and properties for this step.
Returns:
ParameterList with parameters and properties for this step.

equals

public boolean equals(java.lang.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 java.lang.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 java.lang.String toString()
Returns a String representation for this JobSetStep object.
Overrides:
toString in class java.lang.Object
Returns:
a String representation of this JobSetStep.

toDebugString

public java.lang.String toDebugString()
Returns a debug String representation for this JobSetStep object.
Returns:
debug String representation of this JobSetStep.

Skip navigation links

Oracle Enterprise Scheduler Java API Reference
11g Release 1 (11.1.1.7)
E26229-06


Copyright © 2008, 2013, Oracle and/or its affiliates. All rights reserved.