com.ibm.pim.job
Interface ScheduleStatus


public interface ScheduleStatus

Interface that provides information about job schedule status

Since:
6.0.0

Nested Class Summary
static class ScheduleStatus.Type
          This is an enum type for job status.
 
Field Summary
static java.lang.String copyright
           
 
Method Summary
 java.util.Date getEndTime()
          Gets the time at which the schedule exits this status.
 java.lang.String getReturnValue()
          Gets the return value being set to the status.
 int getRunIndex()
          Gets the index for the run of schedule.
 java.util.Date getStartTime()
          Gets the time at which the schedule enters this status.
 ScheduleStatus.Type getType()
          Gets the status type.
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

getType

ScheduleStatus.Type getType()
Gets the status type.

Returns:
one of the pre-defined status types in enum ScheduleStatus.Type.
Throws:
PIMInternalException - If an internal error occurs.

getRunIndex

int getRunIndex()
Gets the index for the run of schedule.

Returns:
the number of index.
Throws:
PIMInternalException - If an internal error occurs.

getReturnValue

java.lang.String getReturnValue()
Gets the return value being set to the status.

Returns:
a string of text describing what happened to reach the status.
Throws:
PIMInternalException - If an internal error occurs.

getStartTime

java.util.Date getStartTime()
Gets the time at which the schedule enters this status.

Returns:
a Date type value denoting the time at which the schedule entered this status.
Throws:
PIMInternalException - If an internal error occurs.

getEndTime

java.util.Date getEndTime()
Gets the time at which the schedule exits this status.

Returns:
a Date type value denoting the time at which the schedule exited this status.
Throws:
PIMInternalException - If an internal error occurs.