Schedule (Plugins 9.0.01-SNAPSHOT API)

java.lang.Object
- com.bmc.arsys.plugins.report.schedule.Schedule

```
public class Schedule
extends Object
```
A generic calendar based schedule with many different settings.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`APRIL` every/only April
`static int`	`AUGUST` every/only August
`static int`	`DAILY` occurs using days
`static int`	`DECEMBER` every/only December
`static int`	`EVERYDAY` every day
`static int`	`FEBRUARY` every/only Febuary
`static int`	`FIRST` first week of month
`static int`	`FOURTH` fourth week of month
`static int`	`FREQUENCY` determines what type of reoccurance to use
`static int`	`FRIDAY` every friday
`static int`	`HOURLY` occurs using hours
`static int`	`JANUARY` every/only January
`static int`	`JULY` every/only July
`static int`	`JUNE` every/only June
`static int`	`LAST` fifth week of month
`static int`	`MARCH` every/only March
`static int`	`MAY` every/only May
`static int`	`MINUTELY` occurs using minute
`static int`	`MONDAY` every monday
`static int`	`MONTHLY` occurs using months
`static int`	`NaN` not a number if a value isn't set
`static int`	`NDAYS` every n days
`static int`	`NFREQUENCY` determines how frequent we execute on
`static int`	`NHOURS` every n hours
`static int`	`NMINUTES` every n minutes
`static int`	`NMONTHS` every n months
`static int`	`NOVEMBER` every/only November
`static int`	`NYEARS` every n years
`static int`	`OCTOBER` every/only October
`static int`	`SATURDAY` every satuarday
`static int`	`SECOND` second week of month
`static int`	`SEPTEMBER` every/only September
`static int`	`serialVersionUID` the serialized version number
`static int`	`SUNDAY` every sunday
`static int`	`THIRD` third week of month
`static int`	`THURSDAY` every thursday
`static int`	`TUESDAY` every tuesday
`static int`	`WEDNESDAY` every wednesday
`static int`	`WEEKDAY` every weekday
`static int`	`WEEKEND_DAY` every weekend day
`static int`	`WEEKLY` occurs using weeks
`static int`	`YEARLY` occurs using years

Constructor Summary

Constructors
Constructor and Description
`Schedule()` create a new empty schedule using the default locale
`Schedule(Locale locale)` create a new empty schedule using the locale provided; this is only used with create/writing a schedule, not when a locale is defined within the schedule stream.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Schedule schedule)` Checks if this schedule is logical equivilent to another schedule.
`static int[]`	`getAllDaysInWeek()` Gets all days in a week.
`static int[]`	`getAllHoursInDay()` get all 24 hours in day
`int`	`getDayOfMonth()` Gets the day of the month for this schedule.
`static String`	`getDaysAsString(int[] days)` encode the days array as a string format listing all the days
`int[]`	`getDaysOfWeek()` Gets the days of the week for this schedule.
`int`	`getFirstDayOfWeek()` Gets the day of the week for this schedule.
`int`	`getFrequency()` get the frequency for this schedule
`static String`	`getHoursAsString(int[] hours)` encode the hours array as a string presentation
`static int[]`	`getHoursBetween(int a, int b)` get all hours between two times [a, b] of the same day
`int[]`	`getHoursOfDay()` Gets the hours of the day for this schedule.
`Date`	`getLastTime(Date now)` get the next time history data should be collected
`Locale`	`getLocale()` get the locale that this schedule is using currently
`int`	`getMonthOfYear()` Gets the month of the year for this schedule.
`Date`	`getNextTime(Date now, boolean useInitialTime)` get the next time history data should be collected
`Date`	`getStartDate()` get the date/time that this schedule starts with used to seed the date/time calculations and set a specific time to begin
`int`	`getSubType()` get the sub-type of this schedule
`int`	`getType()` get the type of this schedule
`static int[]`	`getWeekdays()` gets an array of days in week for weekdays only
`int`	`getWeekOfMonth()` Gets the week of the month for this schedule.
`Date`	`initializeScheduleTimes(boolean useInitialTime)`
`static Schedule`	`parse(int type, Integer frequency, int[] hoursOfDay, int[] daysOfWeek, Integer weekOfMonth, Integer monthOfYear, Integer dayOfMonth, Date startDateTime)` Parses the individual field values to create a schedule object.
`static int[]`	`parseDays(String buf)` Decodes the days in the string representation and returns an array of the days.
`static int[]`	`parseHours(String buf)` Decodes the hours in the string representation and returns an array of the hours.
`static Object[]`	`parseLine(String line, String format)` parse one line of text using the tokens provided returning the tokenized values.
`void`	`setHourly(int hours, int[] daysOfWeek, int[] hoursOfDay)` Sets the schedule to hourly based upon the number of hours, day descriptor and a inclusive time span.
`void`	`setLocale(Locale locale)` change the locale to the new locale and reload resources from the new resource bundle
`void`	`setMinutely(int minutes, int[] daysOfWeek, int[] hoursOfDay)` set the schedule to minutely based upon the number of minutes, day descriptor and a inclusive time span
`void`	`setMonthly(int months, int weekOfMonth, int[] daysOfWeek)` For Type 2, sets the schedule to monthly based upon the week descriptor, day descriptor and month frequency.
`void`	`setMonthlyByDayOfMonth(int months, int dayOfMonth)` Sets the schedule to monthly based upon the day of the month.
`void`	`setStartDate(Date inStart)` set the date/time that this schedule starts with used to seed the date/time calculations and set the specific time to begin
`void`	`setWeekly(int weeks, int[] days)` Sets the schedule to weekly and only execute on days specified.
`void`	`setYearlyByDayOfMonth(int monthOfYear, int day)` Sets the schedule to yearly based upon the number of years, month descriptor and day of the month (based upon the month).
`void`	`setYearlyByDayOfWeek(int weekOfMonth, int[] daysOfWeek, int monthOfYear)` Sets the schedule to yearly based upon the number of years, week descriptor and day of the month (based upon the month).
`String`	`toString()` For debugging purposes, displays the schedule information.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - serialVersionUID
```
public static final int serialVersionUID
```
    the serialized version number
    
    See Also:
    
    Constant Field Values
  - NaN
```
public static final int NaN
```
    not a number if a value isn't set
    
    See Also:
    
    Constant Field Values
  - FREQUENCY
```
public static final int FREQUENCY
```
    determines what type of reoccurance to use
    
    See Also:
    
    Constant Field Values
  - MINUTELY
```
public static final int MINUTELY
```
    occurs using minute
    
    See Also:
    
    Constant Field Values
  - HOURLY
```
public static final int HOURLY
```
    occurs using hours
    
    See Also:
    
    Constant Field Values
  - DAILY
```
public static final int DAILY
```
    occurs using days
    
    See Also:
    
    Constant Field Values
  - WEEKLY
```
public static final int WEEKLY
```
    occurs using weeks
    
    See Also:
    
    Constant Field Values
  - MONTHLY
```
public static final int MONTHLY
```
    occurs using months
    
    See Also:
    
    Constant Field Values
  - YEARLY
```
public static final int YEARLY
```
    occurs using years
    
    See Also:
    
    Constant Field Values
  - NFREQUENCY
```
public static final int NFREQUENCY
```
    determines how frequent we execute on
    
    See Also:
    
    Constant Field Values
  - NMINUTES
```
public static final int NMINUTES
```
    every n minutes
    
    See Also:
    
    Constant Field Values
  - NHOURS
```
public static final int NHOURS
```
    every n hours
    
    See Also:
    
    Constant Field Values
  - NDAYS
```
public static final int NDAYS
```
    every n days
    
    See Also:
    
    Constant Field Values
  - NMONTHS
```
public static final int NMONTHS
```
    every n months
    
    See Also:
    
    Constant Field Values
  - NYEARS
```
public static final int NYEARS
```
    every n years
    
    See Also:
    
    Constant Field Values
  - EVERYDAY
```
public static final int EVERYDAY
```
    every day
    
    See Also:
    
    Constant Field Values
  - WEEKDAY
```
public static final int WEEKDAY
```
    every weekday
    
    See Also:
    
    Constant Field Values
  - WEEKEND_DAY
```
public static final int WEEKEND_DAY
```
    every weekend day
    
    See Also:
    
    Constant Field Values
  - SUNDAY
```
public static final int SUNDAY
```
    every sunday
    
    See Also:
    
    Constant Field Values
  - MONDAY
```
public static final int MONDAY
```
    every monday
    
    See Also:
    
    Constant Field Values
  - TUESDAY
```
public static final int TUESDAY
```
    every tuesday
    
    See Also:
    
    Constant Field Values
  - WEDNESDAY
```
public static final int WEDNESDAY
```
    every wednesday
    
    See Also:
    
    Constant Field Values
  - THURSDAY
```
public static final int THURSDAY
```
    every thursday
    
    See Also:
    
    Constant Field Values
  - FRIDAY
```
public static final int FRIDAY
```
    every friday
    
    See Also:
    
    Constant Field Values
  - SATURDAY
```
public static final int SATURDAY
```
    every satuarday
    
    See Also:
    
    Constant Field Values
  - JANUARY
```
public static final int JANUARY
```
    every/only January
    
    See Also:
    
    Constant Field Values
  - FEBRUARY
```
public static final int FEBRUARY
```
    every/only Febuary
    
    See Also:
    
    Constant Field Values
  - MARCH
```
public static final int MARCH
```
    every/only March
    
    See Also:
    
    Constant Field Values
  - APRIL
```
public static final int APRIL
```
    every/only April
    
    See Also:
    
    Constant Field Values
  - MAY
```
public static final int MAY
```
    every/only May
    
    See Also:
    
    Constant Field Values
  - JUNE
```
public static final int JUNE
```
    every/only June
    
    See Also:
    
    Constant Field Values
  - JULY
```
public static final int JULY
```
    every/only July
    
    See Also:
    
    Constant Field Values
  - AUGUST
```
public static final int AUGUST
```
    every/only August
    
    See Also:
    
    Constant Field Values
  - SEPTEMBER
```
public static final int SEPTEMBER
```
    every/only September
    
    See Also:
    
    Constant Field Values
  - OCTOBER
```
public static final int OCTOBER
```
    every/only October
    
    See Also:
    
    Constant Field Values
  - NOVEMBER
```
public static final int NOVEMBER
```
    every/only November
    
    See Also:
    
    Constant Field Values
  - DECEMBER
```
public static final int DECEMBER
```
    every/only December
    
    See Also:
    
    Constant Field Values
  - FIRST
```
public static final int FIRST
```
    first week of month
    
    See Also:
    
    Constant Field Values
  - SECOND
```
public static final int SECOND
```
    second week of month
    
    See Also:
    
    Constant Field Values
  - THIRD
```
public static final int THIRD
```
    third week of month
    
    See Also:
    
    Constant Field Values
  - FOURTH
```
public static final int FOURTH
```
    fourth week of month
    
    See Also:
    
    Constant Field Values
  - LAST
```
public static final int LAST
```
    fifth week of month
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Schedule
```
public Schedule()
```
    create a new empty schedule using the default locale
  - Schedule
```
public Schedule(Locale locale)
```
    create a new empty schedule using the locale provided; this is only used with create/writing a schedule, not when a locale is defined within the schedule stream. The locale can be changed, after it is read in, by calling
    
    Parameters:
    
    locale - the locale to to create strings within
- Method Detail
  - getLocale
```
public Locale getLocale()
```
    get the locale that this schedule is using currently
    
    Returns:
    
    Locale the locale that we have specified to use
  - setLocale
```
public void setLocale(Locale locale)
```
    change the locale to the new locale and reload resources from the new resource bundle
    
    Parameters:
    
    locale - the locale to change to
  - setStartDate
```
public void setStartDate(Date inStart)
```
    set the date/time that this schedule starts with used to seed the date/time calculations and set the specific time to begin
    
    Parameters:
    
    initial - the initial date/time to start with; can not be null
  - getStartDate
```
public Date getStartDate()
```
    get the date/time that this schedule starts with used to seed the date/time calculations and set a specific time to begin
    
    Returns:
    
    Date the date/time that this schedule starts
  - getType
```
public int getType()
```
    get the type of this schedule
    
    Returns:
    
    int the type of this schedule being on of the types {MINUTELY, HOURLY, DAILY, WEEKLY, MONTHLY, YEARLY}
  - getSubType
```
public int getSubType()
```
    get the sub-type of this schedule
    
    Returns:
    
    int the sub type of this schedule being a type specific sub-type
  - getFrequency
```
public int getFrequency()
```
    get the frequency for this schedule
    
    Returns:
    
    int the frequency of this secheduling being any number; NaN if not initialized
  - getHoursOfDay
```
public int[] getHoursOfDay()
```
    Gets the hours of the day for this schedule.
    
    Returns:
    
    The specific hours of the day being a set of values in the range {0-23}; the array will have zero elements if not applicable or not initialized.
  - getFirstDayOfWeek
```
public int getFirstDayOfWeek()
```
    Gets the day of the week for this schedule.
    
    Returns:
    
    The day of the week being a value in the range {EVERYDAY through SATURDAY} or NaN if not applicable or not initialized.
  - getDaysOfWeek
```
public int[] getDaysOfWeek()
```
    Gets the days of the week for this schedule.
    
    Returns:
    
    The days of the week being a value in the range {SUNDAY through SATURDAY} or null if not applicable or not initialized.
  - getWeekOfMonth
```
public int getWeekOfMonth()
```
    Gets the week of the month for this schedule.
    
    Returns:
    
    The week of the month being a value in the range {FIRST through LAST} or NaN if not applicable or not initialized.
  - getDayOfMonth
```
public int getDayOfMonth()
```
    Gets the day of the month for this schedule.
    
    Returns:
    
    The day of the month being a value for the current month. or NaN if not applicable or not initialized
  - getMonthOfYear
```
public int getMonthOfYear()
```
    Gets the month of the year for this schedule.
    
    Returns:
    
    The month of the year being a value in the range {JANUARY through FEBUARY} or NaN if not applicable or not initialized.
  - setMinutely
```
public void setMinutely(int minutes,
                        int[] daysOfWeek,
                        int[] hoursOfDay)
                 throws OutOfRangeException
```
    set the schedule to minutely based upon the number of minutes, day descriptor and a inclusive time span
    
    Parameters:
    
    minutes - The number of minutes to wait between executions.
    
    daysOfWeek - The day of the week descriptors being one value between {EVERYDAY through SATURDAY}.
    
    hoursOfDay - The hours to include for this schedule.
    
    Throws:
    
    OutOfRangeException
  - setHourly
```
public void setHourly(int hours,
                      int[] daysOfWeek,
                      int[] hoursOfDay)
               throws OutOfRangeException
```
    Sets the schedule to hourly based upon the number of hours, day descriptor and a inclusive time span.
    
    Parameters:
    
    hours - The number of hours to wait between executions.
    
    daysOfWeek - The day of the week descriptors being one value between {EVERYDAY through SATURDAY}.
    
    hoursOfDay - The hours to include for this schedule.
    
    Throws:
    
    OutOfRangeException
  - getWeekdays
```
public static int[] getWeekdays()
```
    gets an array of days in week for weekdays only
    
    Returns:
    
    int[] the week days
  - setWeekly
```
public void setWeekly(int weeks,
                      int[] days)
               throws OutOfRangeException
```
    Sets the schedule to weekly and only execute on days specified.
    
    Parameters:
    
    weeks - The number of weeks to wait between executions.
    
    days - The specific days to execute on witin the range {SUNDAY through SATURDAY}.
    
    Throws:
    
    OutOfRangeException
  - setMonthlyByDayOfMonth
```
public void setMonthlyByDayOfMonth(int months,
                                   int dayOfMonth)
                            throws OutOfRangeException
```
    Sets the schedule to monthly based upon the day of the month.
    
    Parameters:
    
    dayOfMonth - The day of the month.
    
    months - The frequency in months to wait
    
    Throws:
    
    OutOfRangeException
  - setMonthly
```
public void setMonthly(int months,
                       int weekOfMonth,
                       int[] daysOfWeek)
                throws OutOfRangeException
```
    For Type 2, sets the schedule to monthly based upon the week descriptor, day descriptor and month frequency.
    
    Parameters:
    
    months - The frequency in months to wait.
    
    weekOfMonth - The week descriptor being one of {FIRST through LAST}.
    
    daysOfWeek - The days of week descriptor to execute on begin one of {SUNDAY through SATURDAY}.
    
    Throws:
    
    OutOfRangeException
  - setYearlyByDayOfMonth
```
public void setYearlyByDayOfMonth(int monthOfYear,
                                  int day)
                           throws OutOfRangeException
```
    Sets the schedule to yearly based upon the number of years, month descriptor and day of the month (based upon the month).
    
    Parameters:
    
    monthOfYear - The month of year descriptor begin one of {JANUARY through DECEMBER}.
    
    day - The day of the month (1-31) for the month selected
    
    Throws:
    
    OutOfRangeException
  - setYearlyByDayOfWeek
```
public void setYearlyByDayOfWeek(int weekOfMonth,
                                 int[] daysOfWeek,
                                 int monthOfYear)
                          throws OutOfRangeException
```
    Sets the schedule to yearly based upon the number of years, week descriptor and day of the month (based upon the month).
    
    Parameters:
    
    weekOfMonth - The week of the month to execute on being one of (FIRST through LAST).
    
    daysOfWeek - The days of the week to execute on. In actuality this should be an array of 1 element. The field is stored as an array, but for YEARLY scheduling, only one value will be present.
    
    monthOfYear - The month of year descriptor being one of {JANUARY through DECEMBER}.
    
    Throws:
    
    OutOfRangeException - If invalid data passed in.
  - parseLine
```
public static Object[] parseLine(String line,
                                 String format)
                          throws ParseException
```
    parse one line of text using the tokens provided returning the tokenized values.
    
    Parameters:
    
    line - the line of text to be parsed for values
    
    Returns:
    
    String[] the tokenized values
    
    Throws:
    
    ParseException - thrown if the format of the text does not match the expected tokens list
  - parse
```
public static Schedule parse(int type,
                             Integer frequency,
                             int[] hoursOfDay,
                             int[] daysOfWeek,
                             Integer weekOfMonth,
                             Integer monthOfYear,
                             Integer dayOfMonth,
                             Date startDateTime)
```
    Parses the individual field values to create a schedule object.
    
    Parameters:
    
    type - The schedule type.
    
    startDate - The date to use for seed calculations.
    
    frequency - How often to schedule.
    
    hoursOfDay - The hours of the day to execute on.
    
    daysOfWeek - The days of the week to execute on.
    
    weekOfMonth - The week of the month to execute on.
    
    monthOfYear - The month of the year to execute on.
    
    dayOfMonth - The day of the month to execute on.
    
    startDateTime - The start date/time.
    
    Returns:
    
    A Schedule object.
  - getAllHoursInDay
```
public static int[] getAllHoursInDay()
```
    get all 24 hours in day
    
    Returns:
    
    int[] all hours between 0 and 23 in the array
  - getAllDaysInWeek
```
public static int[] getAllDaysInWeek()
```
    Gets all days in a week.
    
    Returns:
    
    All days in the standard week.
  - getHoursAsString
```
public static String getHoursAsString(int[] hours)
```
    encode the hours array as a string presentation
    
    Parameters:
    
    hours - the set of hours to encode
    
    Returns:
    
    String the string representation of the hours
  - getDaysAsString
```
public static String getDaysAsString(int[] days)
```
    encode the days array as a string format listing all the days
    
    Parameters:
    
    days - the days to encode
    
    Returns:
    
    String the encoded string
  - parseHours
```
public static int[] parseHours(String buf)
                        throws ParseException
```
    Decodes the hours in the string representation and returns an array of the hours.
    
    Parameters:
    
    buf - The string representation.
    
    Returns:
    
    The complete set of hours as an array or an empty array if there are none.
    
    Throws:
    
    ParseException
  - parseDays
```
public static int[] parseDays(String buf)
                       throws ParseException
```
    Decodes the days in the string representation and returns an array of the days.
    
    Parameters:
    
    buf - The string representation.
    
    Returns:
    
    The complete set of days as an array or an empty array if there were none.
    
    Throws:
    
    ParseException
  - getHoursBetween
```
public static int[] getHoursBetween(int a,
                                    int b)
```
    get all hours between two times [a, b] of the same day
    
    Returns:
    
    int[] all the hours in the array between the two times; if b is less than a, then null
  - getNextTime
```
public Date getNextTime(Date now,
                        boolean useInitialTime)
                 throws ParseException
```
    get the next time history data should be collected
    
    Returns:
    
    Date the date/time for the next time to collect data
    
    Throws:
    
    ParseException
  - getLastTime
```
public Date getLastTime(Date now)
                 throws ParseException
```
    get the next time history data should be collected
    
    Returns:
    
    Date the date/time for the next time to collect data
    
    Throws:
    
    ParseException
  - toString
```
public String toString()
```
    For debugging purposes, displays the schedule information.
    
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Schedule schedule)
```
    Checks if this schedule is logical equivilent to another schedule.
    
    Parameters:
    
    rhs - The schedule to compare with.
    
    Returns:
    
    True if logically equivilent; false otherwise.
  - initializeScheduleTimes
```
public Date initializeScheduleTimes(boolean useInitialTime)
```

Class Schedule

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

NaN

FREQUENCY

MINUTELY

HOURLY

DAILY

WEEKLY

MONTHLY

YEARLY

NFREQUENCY

NMINUTES

NHOURS

NDAYS

NMONTHS

NYEARS

EVERYDAY

WEEKDAY

WEEKEND_DAY

SUNDAY

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

JANUARY

FEBRUARY

MARCH

APRIL

MAY

JUNE

JULY

AUGUST

SEPTEMBER

OCTOBER

NOVEMBER

DECEMBER

FIRST

SECOND

THIRD

FOURTH

LAST

Constructor Detail

Schedule

Schedule

Method Detail

getLocale

setLocale

setStartDate

getStartDate

getType

getSubType

getFrequency

getHoursOfDay

getFirstDayOfWeek

getDaysOfWeek

getWeekOfMonth

getDayOfMonth

getMonthOfYear

setMinutely

setHourly

getWeekdays

setWeekly

setMonthlyByDayOfMonth

setMonthly

setYearlyByDayOfMonth

setYearlyByDayOfWeek

parseLine

parse

getAllHoursInDay

getAllDaysInWeek

getHoursAsString

getDaysAsString

parseHours