|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ScheduleService
The schedule service provides methods to manage the life cycle of a schedule. User must have Manage My Schedules or Manage All Schedules privilege to use these methods.
Method Summary | |
---|---|
Schedule |
createSchedule(String name,
String description,
Schedulable schedulable,
ScheduleTrigger trigger)
Creates a schedule that will run the job specified in the scheduleable at the specified time(s) defined in the trigger |
void |
deleteSchedule(ScheduleDescriptor schedule)
Deletes the specified schedule |
Set<ScheduleDescriptor> |
getAllSchedules()
Get all schedules defined in the system. |
Schedule |
getScheduleByDescriptor(ScheduleDescriptor schedule)
Get the full client representation of a schedule from their scheduleDescriptor. |
Set<ScheduleDescriptor> |
getSchedulesForCurrentUser()
Get all schedules defined in the system for the current user. |
boolean |
isRepositoryJobScheduled(String jobPath)
Determines if any schedules for the specified repository job exist. |
boolean |
isWorkspaceJobScheduled(String jobPath)
Determines if any schedules for the specified workspace job exist. |
void |
pauseSchedule(ScheduleDescriptor schedule)
Pauses the specified schedule. |
void |
resumeSchedule(ScheduleDescriptor schedule)
Resumes the specified schedule |
boolean |
scheduleExists(String scheduleName)
Determines if a schedule with the specified name exists. |
Schedule |
updateSchedule(Schedule schedule)
Updates the specified schedule |
Method Detail |
---|
Schedule createSchedule(String name, String description, Schedulable schedulable, ScheduleTrigger trigger) throws ScheduleException
name
- The name of the schedule.description
- The description of the schedule. This value is not required and can be null.schedulable
- Represents the item to run when the schedule fires.trigger
- The mechanism by which the job specified in the Schedulable is scheduled
ScheduleException
- Thrown when the schedule cannot be created.Schedule updateSchedule(Schedule schedule) throws ScheduleException, ScheduleNotFoundException
schedule
- The schedule in which to update
ScheduleException
- Thrown when the schedule cannot be updated.
ScheduleNotFoundException
- Thrown when the schedule cannot be found.void deleteSchedule(ScheduleDescriptor schedule) throws ScheduleException, ScheduleNotFoundException
schedule
- The schedule to be deleted
ScheduleException
- Thrown when the schedule cannot be deleted.
ScheduleNotFoundException
- Thrown when the schedule cannot be found.Schedule getScheduleByDescriptor(ScheduleDescriptor schedule) throws ScheduleException, ScheduleNotFoundException
schedule
- - The scheduleDescriptor of the Schedule to be retrieved.
ScheduleException
- Thrown when the schedule cannot be retrieved.
ScheduleNotFoundException
- Thrown when the schedule cannot be found.Set<ScheduleDescriptor> getAllSchedules() throws ScheduleException
ScheduleException
- Thrown when all schedules cannot be retrieved.Set<ScheduleDescriptor> getSchedulesForCurrentUser() throws ScheduleException
ScheduleException
- Thrown when the schedules cannot be retrieved.void pauseSchedule(ScheduleDescriptor schedule) throws ScheduleException, ScheduleNotFoundException
schedule
- The schedule to be paused.
ScheduleException
- Thrown when the schedule cannot be paused.
ScheduleNotFoundException
- Thrown when the schedule cannot be found.void resumeSchedule(ScheduleDescriptor schedule) throws ScheduleException, ScheduleNotFoundException
schedule
- The schedule to be resumed.
ScheduleException
- Thrown when the schedule cannot be resumed.
ScheduleNotFoundException
- Thrown when the schedule cannot be found.boolean scheduleExists(String scheduleName) throws ScheduleException
scheduleName
- The schedule name to look for.
ScheduleException
- Thrown when schedules cannot be retrieved due to insufficient privilege.boolean isRepositoryJobScheduled(String jobPath) throws ScheduleException
jobPath
- Path of the job in the repository
ScheduleException
- Thrown when schedules cannot be retrieved due to insufficient privilege.boolean isWorkspaceJobScheduled(String jobPath) throws ScheduleException
jobPath
- Path of the job in the workspace
ScheduleException
- Thrown when schedules cannot be retrieved due to insufficient privilege.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |