|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.cert.cc.jira.ReportScheduler
public final class ReportScheduler
© 2010 Carnegie Mellon University
Constructor Summary | |
---|---|
ReportScheduler()
Base Constructor that sets up the Scheduler to use. |
Method Summary | |
---|---|
void |
deleteScheduledReport(String reportName,
String groupName)
Method to remove Trigger from the Scheduler . |
String[] |
getAllScheduledReportsByGroupName(String groupName)
Method to retrieve a string array of all the names of the Trigger s with in a specified Group. |
Trigger |
getScheduledReportTrigger(String reportName,
String groupName)
Method for retrieving a Trigger by name and group name. |
Trigger |
scheduleReport(String reportName,
String groupName,
Class jobClass,
String cronExpression,
Map map)
Method to schedule a report Trigger with the Scheduler . |
void |
unscheduleAllReportsByGroupName(String groupName)
Method for removing all Trigger s and all related Job s specified
by a String representing the group. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ReportScheduler()
Scheduler
to use.
Method Detail |
---|
public Trigger getScheduledReportTrigger(String reportName, String groupName)
Trigger
by name and group name.
reportName
- - String
Name to use for Trigger.groupName
- - String
Name to use for the group.
Trigger
public Trigger scheduleReport(String reportName, String groupName, Class jobClass, String cronExpression, Map map)
Trigger
with the Scheduler
. This will also register the
associated Job
with the Scheduler
and Trigger
.
reportName
- String
Name to use for the trigger. Must be distinct in the Group.groupName
- String
Name to use for the Group to put the Trigger
in.jobClass
- Job
to register for the Trigger
to fire.cronExpression
- String
cron expression to use to schedule when to fire.
Trigger
after it has been created and scheduled.public void unscheduleAllReportsByGroupName(String groupName) throws Exception
Trigger
s and all related Job
s specified
by a String
representing the group.
groupName
- - String
Name of the group.
Exception
- - Exception
thrown on failure to remove all Trigger
s and associated Job
s.public void deleteScheduledReport(String reportName, String groupName) throws SchedulerException
Trigger
from the Scheduler
.
Note: This still leaves the Job
registered with the Scheduler
.
I left this in case multiple triggers use the same job.
reportName
- - String
Name of the Trigger
.groupName
- - String
Name of the group the Trigger
belongs too.
SchedulerException
- - SchedulerException
thrown if there is a failure removing the Trigger
.public String[] getAllScheduledReportsByGroupName(String groupName)
Trigger
s with in a specified Group.
groupName
- String
Name of the Group.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |