|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Schedule
This is the interface for a job schedule. A job schedule is to define what is the job and when to start the job.
Nested Class Summary | |
---|---|
static class |
Schedule.Type
This is an enum type for schedule type. |
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Method Summary | |
---|---|
void |
delete()
Delete the job schedule. |
User |
getCreator()
Gets the creator of the schedule. |
boolean |
getEnabled()
Indicates if the schedule is enabled or not. |
java.util.List<ScheduleStatus> |
getHistory()
Gets all statuses that the schedule went through, including the latest status. |
Job |
getJob()
Get the job to be scheduled. |
ScheduleStatus |
getLatestCompletedStatus()
Gets the completed status of last run schedule. |
int |
getLatestRunCompletionPercentage()
Gets the completion percentage of the specified job schedule and return percent complete as integer number if the job is currently running, -1 otherwise. |
java.lang.String |
getName()
Gets schedule name. |
java.util.Date |
getNextRunningTime()
Gets the next running time of a job schedule. |
java.util.Collection<java.lang.String> |
getParameterNames()
Gets the names of all parameters for the job schedule. |
java.lang.String |
getParameterValue(java.lang.String parameterName)
Gets the value for the specific parameter. |
java.util.Date |
getStartTime()
Gets the start time info of a job schedule. |
Schedule.Type |
getType()
Gets schedule type. |
void |
save()
Saves the job schedule. |
void |
setEnabled(boolean isEnabled)
Enables or disables a schedule. |
void |
setNextRunningTime(java.util.Date nextRunningTime)
Sets the next running time of a schedule. |
void |
setParameterValue(java.lang.String parameterName,
java.lang.String parameterValue)
Sets parameter for the job schedule. |
void |
stop()
Stops the specified job schedule if it is currently running. |
Field Detail |
---|
static final java.lang.String copyright
Method Detail |
---|
java.lang.String getName()
PIMInternalException
- If an internal error occurs.Schedule.Type getType()
PIMInternalException
- If an internal error occurs.Job getJob()
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use.java.util.Collection<java.lang.String> getParameterNames()
PIMInternalException
- If an internal error occurs.java.lang.String getParameterValue(java.lang.String parameterName)
parameterName
- the parameter name
PIMInternalException
- If an internal error occurs.
java.lang.IllegalArgumentException
- If parameterName is null or empty.void setParameterValue(java.lang.String parameterName, java.lang.String parameterValue)
parameterName
- the parameter nameparameterValue
- the value String
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use.
java.lang.IllegalArgumentException
- If parameterName or parameterValue is null or empty.ScheduleStatus getLatestCompletedStatus()
PIMInternalException
- If an internal error occurs.java.util.List<ScheduleStatus> getHistory()
PIMInternalException
- If an internal error occurs.int getLatestRunCompletionPercentage()
PIMInternalException
- If an internal error occurs.java.util.Date getNextRunningTime()
PIMInternalException
- If an internal error occurs.void setNextRunningTime(java.util.Date nextRunningTime)
nextRunningTime
- a date for next run of a job schedule
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use.
java.lang.IllegalArgumentException
- If nextRunningTime is null.java.util.Date getStartTime()
PIMInternalException
- If an internal error occurs.boolean getEnabled()
PIMInternalException
- If an internal error occurs.void setEnabled(boolean isEnabled)
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- If the user is not allowed to perform this operationvoid save()
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use.void delete()
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use.void stop()
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use.User getCreator()
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |