com.crystaldecisions.sdk.plugin.desktop.calendar
Interface IBusinessCalendarDays

All Superinterfaces:

java.util.Collection, java.util.List

public interface IBusinessCalendarDays

extends java.util.List

Stores a collection of IBusinessCalendarDay objects.

Method Summary

IBusinessCalendarDay	add() Shortcut for add( IBusinessCalendarDay.ALL, IBusinessCalendarDay.ALL, IBusinessCalendarDay.ALL, IBusinessCalendarDay.ALL, IBusinessCalendarDay.ALL, IBusinessCalendarDay.ALL, IBusinessCalendarDay.ALL, IBusinessCalendarDay.ALL).
IBusinessCalendarDay	add(int startDay, int startMonth, int startYear, int endDay, int endMonth, int endYear, int dayOfWeek, int weekOfMonth, int group) Adds a new Business Calendar day to the collection.
int	getNextGroupID() Returns the next available group ID.

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

public IBusinessCalendarDay add(int startDay,
                                int startMonth,
                                int startYear,
                                int endDay,
                                int endMonth,
                                int endYear,
                                int dayOfWeek,
                                int weekOfMonth,
                                int group)

Adds a new Business Calendar day to the collection.

Note:All of the specified parameters must be true for the scheduled job to run.

Parameters:

startDay - The day of the month when the schedule runs. startDay can be a value from 1-31.

startMonth - The month when the schedule runs. startMonth can be a valid value representing Calendar.MONTH field in the fields of Calendar, or IBusinessCalendarDay.ALL, which means every month in the year.

startYear - The year when the schedule runs. startYear can be any valid year.

endDay - The day of the month when the schedule runs.

endMonth - The month when the schedule runs. endMonth can be a valid value representing Calendar.MONTH field in the fields of Calendar, or IBusinessCalendarDay.ALL, which means every month in the year.

endYear - The year when the schedule stops running.

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

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

group - The group ID of the Business Calendar template.

Returns:

An IBusinessCalendarDay object containing the new Business Calendar template.

add

public IBusinessCalendarDay add()

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

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

Returns:

An IBusinessCalendarDay object containing the new Business Calendar template.

getNextGroupID

public int getNextGroupID()

Returns the next available group ID.

Returns:

An int containing the next available group ID.