com.crystaldecisions.sdk.occa.infostore
Interface ICalendarRunDays

All Superinterfaces:

java.util.Collection, java.lang.Iterable, java.util.List

public interface ICalendarRunDays
extends java.util.List

This interface allows you to create a calendar template, which is a user-defined set of days that can be used for scheduling a job. For example, if you want a job to run only on Tuesdays and Thursdays during the next year, you can add two CalendarDay objects to the collection: one that runs the job on Tuesday and one that runs it on Thursday.

Note: ICalendarRunDays is a collection of calendar templates.

Method Summary

ICalendarDay	add() Shortcut for add( ICalendarDay.ALL, ICalendarDay.ALL, ICalendarDay.ALL, ICalendarDay.ALL, ICalendarDay.ALL, ICalendarDay.ALL, ICalendarDay.ALL, ICalendarDay.ALL).
ICalendarDay	add(int startDay, int startMonth, int startYear, int endDay, int endMonth, int endYear, int dayOfWeek, int weekOfMonth) Adds a Calendar template to the collection.

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Method Detail

add

ICalendarDay add(int startDay,
                 int startMonth,
                 int startYear,
                 int endDay,
                 int endMonth,
                 int endYear,
                 int dayOfWeek,
                 int weekOfMonth)

Adds a Calendar template to the collection. A job scheduled using this template will be run when all the conditions specified are true.

Parameters:

startDay - The day of the month on which the schedule will begin running. startDay can be a value from 1-31.

startMonth - The month in which the schedule will begin running. startMonth can be a valid value representing java.util.Calendar.MONTH field in the fields of java.util.Calendar, or ICalendarDay.ALL, which means every month in the year.

startYear - The year in which the schedule will begin running. startYear can be any valid year.

endDay - The day of the month on which the schedule will stop running.

endMonth - The month in which the schedule will stop running, which can be a valid value representing java.util.Calendar.MONTH field in the fields of java.util.Calendar, or ICalendarDay.ALL, which means every month in the year.

endYear - The year in which the schedule will stop running.

dayOfWeek - The day(s) on which the job will be processed. The value can be set to a specific day or to ICalendarDay.ALL, which means all days of the week.

weekOfMonth - The specific week in which the job will be processed. 1 is the first week of the month; 5 is the last week. ICalendarDay.ALL is every week.

Returns:

An ICalendarDay object containing the created calendar template.

add

ICalendarDay add()

Shortcut for add( ICalendarDay.ALL, ICalendarDay.ALL, ICalendarDay.ALL, ICalendarDay.ALL, ICalendarDay.ALL, ICalendarDay.ALL, ICalendarDay.ALL, ICalendarDay.ALL).

The return object can be used to qualify the template. This is a template that can be used to schedule reports.

Returns:

An ICalendarDay object containing the created calendar template.