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

public interface IBusinessCalendarDay

This interface allows you to customize the scheduling information used in your Business Calendar template.

This interface allows you to set the run days for your business calendar.

Field Summary

static int	ALL Indicates that the job runs on all the possible values of the specified time field.
static int	FINAL_WEEK Indicates that the job runs in the last 7 days of the month.

Method Summary

int	getDayOfWeek() Returns a specific day of the week (Calendar) or all week (IBusinessCalendarDay.ALL).
int	getEndDay() Returns the day on which the schedule stops running.
int	getEndMonth() Returns the month when the schedule stops running.
int	getEndYear() Returns the year in which the schedule will stop running.
int	getGroupID() Returns the group ID associated with this Business Calendar Day.
int	getStartDay() Returns the day when the schedule will being running.
int	getStartMonth() Returns the month when the schedule will begin running.
int	getStartYear() Returns the year in which the schedule will begin running.
int	getWeekNumber() Returns the specific week in the month when the job will be processed.
void	setDayOfWeek(int dayOfWeek) Sets the day of the week that the job will run.
void	setEndDay(int day) Sets the day on which the schedule stops running.
void	setEndMonth(int month) Sets the month in which the schedule stops running.
void	setEndYear(int year) Sets the year in which the schedule will stop running.
void	setGroupID(int groupNum) Sets the group ID for this Business Calendar Day.
void	setStartDay(int day) Sets the day when the schedule will begin running.
void	setStartMonth(int month) Sets the month in which the schedule will begin running.
void	setStartYear(int year) Sets the year in which the schedule will begin running.
void	setWeekNumber(int week) Sets the specific week in the month in which the job will be processed.

Field Detail

ALL

static final int ALL

Indicates that the job runs on all the possible values of the specified time field.

See Also:

Constant Field Values

FINAL_WEEK

static final int FINAL_WEEK

Indicates that the job runs in the last 7 days of the month.

See Also:

Constant Field Values

Method Detail

getStartYear

int getStartYear()

Returns the year in which the schedule will begin running.

Returns:

An int specifying the start year.

setStartYear

void setStartYear(int year)

Sets the year in which the schedule will begin running.

Parameters:

year - An int specifying the start year.

getStartMonth

int getStartMonth()

Returns the month when the schedule will begin running. The return value can be evaluated as one of the fields representing Calendar.MONTH field in Calendar, or IBusinessCalendarDay.ALL, which means every month in a year.

Returns:

An int specifying the start month.

setStartMonth

void setStartMonth(int month)

Sets the month in which the schedule will begin running. The value can be evaluated as one of the fields representing Calendar.MONTH field in Calendar, or IBusinessCalendarDay.ALL, which means every month in the year.

Parameters:

month - An int specifying the start month.

getStartDay

int getStartDay()

Returns the day when the schedule will being running.

Returns:

An int specifying the start day.

setStartDay

void setStartDay(int day)

Sets the day when the schedule will begin running.

Parameters:

day - An int specifying the start day.

getEndYear

int getEndYear()

Returns the year in which the schedule will stop running.

Returns:

An int specifying the end year.

setEndYear

void setEndYear(int year)

Sets the year in which the schedule will stop running.

Parameters:

year - An int specifying the end year.

getEndMonth

int getEndMonth()

Returns the month when the schedule stops running. The return value can be evaluated as one of the fields representing Calendar.MONTH field in Calendar, or IBusinessCalendarDay.ALL, which means every month in the year.

Returns:

An int specifying the end month.

setEndMonth

void setEndMonth(int month)

Sets the month in which the schedule stops running. The value can be evaluated as one of the fields representing Calendar.MONTH field in Calendar, or IBusinessCalendarDay.ALL, which means every month in the year.

Parameters:

month - An int value representing the end month.

getEndDay

int getEndDay()

Returns the day on which the schedule stops running.

Returns:

An int specifying the end day.

setEndDay

void setEndDay(int day)

Sets the day on which the schedule stops running.

Parameters:

day - An int value representing the end day.

getWeekNumber

int getWeekNumber()

Returns the specific week in the month when the job will be processed. The number of the week is represented by an int. 1 represents the first week of the month while 5 is the last week of the month. A special value of 6 can also be returned representing the last 7 days of a month which might partially included logical week 4 and 5. The default is IBusinessCalendarDay.ALL, which means the job will run every week in the month.

Returns:

An int specifying the week of the month.

setWeekNumber

void setWeekNumber(int week)

Sets the specific week in the month in which the job will be processed. The number of the week is represented by an int. 1 represents the first week of the month while 5 is the last week of the month. A special value of 6 is also accepted and denotes the last 7 days of a month which might partially include logical week 4 and 5. The default is IBusinessCalendarDay.ALL, which means the job will run every week in the month.

Parameters:

week - An int specifying the week of the month. Possible values range from 1 to 5 with IBusinessCalendarDay.ALL meaning every week.

setDayOfWeek

void setDayOfWeek(int dayOfWeek)

Sets the day of the week that the job will run. This can be a specific day (one of the fields representing Calendar.DAY_OF_WEEK) or all week (IBusinessCalendarDay.ALL).

Parameters:

dayOfWeek - An int representing the days of the week when the job runs. The value of the argument is evaluated as one of the fields representing Calendar.DAY_OF_WEEK in Calendar, or IBusinessCalendarDay.ALL, which means everyday of the week.

getDayOfWeek

int getDayOfWeek()

Returns a specific day of the week (Calendar) or all week (IBusinessCalendarDay.ALL).

Returns:

An int specifying the days of the week when the job runs. The return type can also be evaluated as one of the fields representing Calendar.DAY_OF_WEEK in Calendar, or IBusinessCalendarDay.ALL, which means everyday of the week.

setGroupID

void setGroupID(int groupNum)

Sets the group ID for this Business Calendar Day.

Parameters:

groupNum - An int representing a group ID.

getGroupID

int getGroupID()

Returns the group ID associated with this Business Calendar Day.

Returns:

An int specifying the group ID of this Business Calendar Day.