|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Specifies the time frames during which the schedule will be active.
The schedule is active as soon as the start time - if supplied - is reached. The schedule remains active until the stop time - if supplied - is reached. If no stop time is specified the schedule will active indefinitely. The time frame defined by the schedule may contain one or more intervals. These intervals may repeat on a daily and/or weekly basis and specify the time periods during which the schedule is active. A daily schedule includes a start time and end time, which lie between 00.00 and 24.00 hours. If daily schedule is omitted, the schedule will run continuously through the day. If weekly schedule is omitted the schedule will run all days of the week. Alternatively the weekly schedule will indicate which days of the week the schedule will be active on.
The timer-synchronization between the client and the server is not part of this interface and is left over to the implementers. However the implementations need to handle different time zones.
Method Summary | |
java.lang.Object |
clone()
Deep copy of this instance. |
DailySchedule |
getDailySchedule()
Gets the daily schedule of the schedule. |
java.util.Calendar |
getStartTime()
Returns the start time. |
java.util.Calendar |
getStopTime()
Returns the stop time of the schedule. |
WeeklySchedule |
getWeeklySchedule()
Gets the weekly schedule of the schedule. |
boolean |
isActive()
Checks if the schedule is active or not. |
DailySchedule |
makeDailySchedule()
Creates a new instance of the DailySchedule interface. |
WeeklySchedule |
makeWeeklySchedule()
Creates a new instance of the WeeklySchedule interface. |
void |
setDailySchedule(DailySchedule dailySchedule)
Sets the daily schedule of the schedule. |
void |
setStartTime(java.util.Calendar startTime)
Sets the start time of the schedule. |
void |
setStopTime(java.util.Calendar stopTime)
Sets the stop time of the schedule. |
void |
setWeeklySchedule(WeeklySchedule weekSchedule)
Sets the weekly schedule of the schedule. |
Method Detail |
public java.lang.Object clone()
public WeeklySchedule makeWeeklySchedule()
public DailySchedule makeDailySchedule()
public boolean isActive()
If the current date and time is within the defined schedule this method will return true. If the current date and time is outside the schedule false will be returned.
public java.util.Calendar getStartTime()
setStartTime(java.util.Calendar)
public void setStartTime(java.util.Calendar startTime)
The start time specifies when the schedule shall start to be active. If no start time is provided, the schedule is active immediately.
If start time is null the start time will be cleared.
startTime
- Start time of the schedule.getStartTime()
public java.util.Calendar getStopTime()
setStopTime(java.util.Calendar)
public void setStopTime(java.util.Calendar stopTime)
The stop time specifies when the schedule shall stop. The schedule will remain active until the stop time - if set - is reached. If no stop time is specified the schedule will be active indefinitely.
If stop time is null the stop time will be cleared.
stopTime
- Stop time of the measurement job.getStopTime()
public WeeklySchedule getWeeklySchedule()
setWeeklySchedule(com.sun.management.oss.pm.util.WeeklySchedule)
public void setWeeklySchedule(WeeklySchedule weekSchedule)
The weekly schedule specifies which day of the week the schedule will be active. If weekly schedule is omitted the schedule will run all days of the week.
If weekly schedule is null the weekly schedule will be cleared.
weekSchedule
- The weekly schedule of the schedule.getWeeklySchedule()
public DailySchedule getDailySchedule()
setDailySchedule(com.sun.management.oss.pm.util.DailySchedule)
public void setDailySchedule(DailySchedule dailySchedule)
The daily schedule specifies the time frames during the day that the schedule will be active. If daily schedule is omitted, the schedule will run continuously through the day.
If daily schedule is null the daily schedule will be cleared.
dailySchedule
- The daily schedule of the schedule.getDailySchedule()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |