com.ibm.tws.objects.plan.utils
Class RerunDetails

java.lang.Object
  extended bycom.ibm.tws.objects.plan.utils.RerunDetails
All Implemented Interfaces:
java.io.Serializable

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

This class is used as a parameter in the rerunJobInstance API, in order to pass in a single object all the needed parameters. Note that if during the rerun operation the parameter jobDefinitionDbIdentifier is specified then a 'rerun from' operation is performed, and then the operation will fail if not performed on the MDM.

The following syntax validation constraints must be met on RerunDetails objects:

jobDefinitionDbIdentifier If specified, the Identifier of an
existing database DistJobDefinition
priority Valid values 0-101. Default value 10.
startTime Default value is null.
asap Default value is false
stepName Default value is null.
Specify it if you would like to perform a 'rerun step'.

See Also:
com.ibm.tws.conn.plan.Plan, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
RerunDetails()
          Empty constructor.
RerunDetails(java.util.Date startTime, int priority, Identifier fromJobId, boolean asap)
          Constructor used to make a 'rerun from' with some other constrain.
RerunDetails(Identifier fromJobId)
          Constructor used to make a simple 'rerun from'.
RerunDetails(Identifier fromJobId, java.lang.String stepName)
          Constructor used to make a 'rerun from' with 'rerun step'.
RerunDetails(java.lang.String stepName)
          Constructor used to make a 'rerun step'.
 
Method Summary
 Identifier getJobDefinitionDbIdentifier()
          Returns the Database Job Definition Identifier.
 int getPriority()
          Returns the Priority
 java.util.Date getStartTime()
          Returns the start time
 java.lang.String getStepName()
          Returns the step name
 boolean isAsap()
          Returns true if the job should be re-run immediately, false otherwise.
 void setAsap(boolean b)
          Sets if the job should be re-run immediately
 void setJobDefinitionDbIdentifier(Identifier identifier)
          Sets the Database Job Definition Identifier.
 void setPriority(int i)
          Sets the Priority
 void setStartTime(java.util.Date l)
          Sets the job start time.
 void setStepName(java.lang.String string)
          Sets the step name.
 java.lang.String toString()
          Returns a String representation of this object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright.

Constructor Detail

RerunDetails

public RerunDetails()
Empty constructor. Used to make a simple 'rerun'.


RerunDetails

public RerunDetails(java.lang.String stepName)
Constructor used to make a 'rerun step'.

Parameters:
stepName - The Job step name.

RerunDetails

public RerunDetails(Identifier fromJobId)
Constructor used to make a simple 'rerun from'.

Parameters:
fromJobId - the Database Job Definition Identifier.

RerunDetails

public RerunDetails(Identifier fromJobId,
                    java.lang.String stepName)
Constructor used to make a 'rerun from' with 'rerun step'.

Parameters:
fromJobId - the Database Job Definition Identifier.
stepName - The Job step name.

RerunDetails

public RerunDetails(java.util.Date startTime,
                    int priority,
                    Identifier fromJobId,
                    boolean asap)
Constructor used to make a 'rerun from' with some other constrain.

Parameters:
startTime - The Job start time.
priority - The Job priority
fromJobId - The Database Job Definition Identifier
asap - a boolean representing if the Job should be re-run immediately or not.
Method Detail

getStartTime

public java.util.Date getStartTime()
Returns the start time

Returns:
the start time

getJobDefinitionDbIdentifier

public Identifier getJobDefinitionDbIdentifier()
Returns the Database Job Definition Identifier.

Returns:
the Database Job Definition Identifier.

getPriority

public int getPriority()
Returns the Priority

Returns:
the Priority

getStepName

public java.lang.String getStepName()
Returns the step name

Returns:
the step name

setJobDefinitionDbIdentifier

public void setJobDefinitionDbIdentifier(Identifier identifier)
Sets the Database Job Definition Identifier.

Parameters:
identifier - the Database Job Definition Identifier to set.

setPriority

public void setPriority(int i)
Sets the Priority

Parameters:
i - the priority to set.

setStepName

public void setStepName(java.lang.String string)
Sets the step name.

Parameters:
string - the step name to set..

toString

public java.lang.String toString()
Returns a String representation of this object.

Returns:
a String representation of this object.
See Also:
Object.toString()

isAsap

public boolean isAsap()
Returns true if the job should be re-run immediately, false otherwise.

Returns:
true if the job should be re-run immediately, false otherwise.

setAsap

public void setAsap(boolean b)
Sets if the job should be re-run immediately

Parameters:
b - true if the job should be re-run immediately, false otherwise.

setStartTime

public void setStartTime(java.util.Date l)
Sets the job start time.

Parameters:
l - the job start time to set.


Copyright © 2005 IBM All Rights Reserved.