|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Job
This interface defines methods for scheduler job.
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Method Summary | |
---|---|
void |
delete()
Delete the job. |
User |
getCreator()
Gets the creator of the job. |
java.lang.String |
getDescription()
Gets job description. |
Executable |
getExecutable()
Retrieves the job executable object. |
Schedule |
getLastRunSchedule()
Get the last run schedule. |
java.util.List<java.lang.String> |
getParameterNames()
Gets the names of all parameters for the job. |
java.lang.String |
getParameterValue(java.lang.String parameterName)
Gets the value for the specified parameter. |
boolean |
getRecurring()
Indicates if the job can be recurring. |
java.util.Collection<Schedule> |
getSchedules()
Gets all the schedules for the given job. |
void |
save()
Saves the job. |
void |
setParameterValue(java.lang.String parameterName,
java.lang.String parameterValue)
Sets the parameter value for the job schedule. |
void |
setRecurring(boolean isRecurring)
Enables or disables the job to be recurring.A job can be recurring if the job can be scheduled to run more than one time, i.e. |
Field Detail |
---|
static final java.lang.String copyright
Method Detail |
---|
java.lang.String getDescription()
PIMInternalException
- If an internal error occurs.Executable getExecutable()
PIMInternalException
- If an internal error occurs.java.util.List<java.lang.String> getParameterNames()
PIMInternalException
- If an internal error occurs.java.lang.String getParameterValue(java.lang.String parameterName)
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.boolean getRecurring()
PIMInternalException
- If an internal error occurs.void setRecurring(boolean isRecurring)
isRecurring
- true for recurring, or false non-recurring
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use.java.util.Collection<Schedule> getSchedules()
PIMInternalException
- If an internal error occurs.void 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.Schedule getLastRunSchedule()
PIMInternalException
- If an internal error occurs.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 |