com.ibm.websphere.batch
Class StepStatusJMXNotificationData

java.lang.Object
  extended by com.ibm.websphere.batch.StepStatusJMXNotificationData
All Implemented Interfaces:
java.io.Externalizable, java.io.Serializable

public class StepStatusJMXNotificationData
extends java.lang.Object
implements java.io.Externalizable

Components can register to SchedulerMBean to be notified on job step state changes. Two types of events are fired for every single job step. These are

step.state.started notification contains step identity, job identity and start time and the status.

step.state.ended notification contains end time and step return code along with the information in the started notification. Please refer to com.ibm.wsspi.batch.BatchSPIConstants for the step status constants.

See Also:
Serialized Form

Field Summary
static java.lang.String STEP_STATE_ENDED
           
static java.lang.String STEP_STATE_STARTED
           
 
Constructor Summary
StepStatusJMXNotificationData()
           
 
Method Summary
 java.lang.String getEndTime()
          Gets the clock time when the step finished executing on the endpoint.
 java.lang.String getJobId()
          Gets the job id associated with this StepStatus notification data
 int getRC()
          Gets the step return code
 java.lang.String getStartTime()
          Gets the clock time when the step started executing on the endpoint.
 int getStatus()
          Gets the status of the step
 java.lang.String getStepId()
          Gets the step id associated with this notification data
 void readExternal(java.io.ObjectInput in)
           
 void setEndTime(java.lang.String time)
           
 void setJobId(java.lang.String jobid)
           
 void setRC(int rc)
           
 void setStartTime(java.lang.String time)
           
 void setStatus(int status)
           
 void setStepName(java.lang.String stepName)
           
 java.lang.String toString()
           
 void writeExternal(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

STEP_STATE_STARTED

public static final java.lang.String STEP_STATE_STARTED
See Also:
Constant Field Values

STEP_STATE_ENDED

public static final java.lang.String STEP_STATE_ENDED
See Also:
Constant Field Values
Constructor Detail

StepStatusJMXNotificationData

public StepStatusJMXNotificationData()
Method Detail

getJobId

public java.lang.String getJobId()
Gets the job id associated with this StepStatus notification data


getStepId

public java.lang.String getStepId()
Gets the step id associated with this notification data


getStatus

public int getStatus()
Gets the status of the step


getRC

public int getRC()
Gets the step return code


getStartTime

public java.lang.String getStartTime()
Gets the clock time when the step started executing on the endpoint.


getEndTime

public java.lang.String getEndTime()
Gets the clock time when the step finished executing on the endpoint.


toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

setJobId

public void setJobId(java.lang.String jobid)

setStatus

public void setStatus(int status)

setStartTime

public void setStartTime(java.lang.String time)
Parameters:
time - the _startTime to set

setEndTime

public void setEndTime(java.lang.String time)

setRC

public void setRC(int rc)

setStepName

public void setStepName(java.lang.String stepName)