com.crystaldecisions.sdk.occa.infostore
Interface ICalendarDay

public interface ICalendarDay

This interface is used to store the information used in calendar-based scheduling. Each CalendarDay indicates the day of the week on which a job will be run over a specified period of time. The job may be run on all days of the week.

Field Summary

static int	ALL This constant value specifies that the job will run on all the possible values of the specified time field.
static int	FINAL_WEEK This constant value specifies that the job will run in the last 7 days of a month.

Method Summary

int	getDayOfWeek() Returns a specific day of the week (java.util.Calendar) or all week (ALL).
int	getEndDay() Returns the day on which the schedule will stop running.
int	getEndMonth() Returns the month in which the schedule will stop running.
int	getEndYear() Returns the year in which the schedule will stop running.
int	getStartDay() Returns the day on which the schedule will being running.
int	getStartMonth() Returns the month in which 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 in which the job will be processed.
void	setDayOfWeek(int dayOfWeek) Sets the day of the week the job will be run.
void	setEndDay(int day) Sets the day on which the schedule will stop running.
void	setEndMonth(int month) Sets the month in which the schedule will stop running.
void	setEndYear(int year) Sets the year in which the schedule will stop running.
void	setStartDay(int day) Sets the day on which 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

This constant value specifies that the job will run on all the possible values of the specified time field.

See Also:

Constant Field Values

FINAL_WEEK

static final int FINAL_WEEK

This constant value specifies that the job will run in the last 7 days of a 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 in which the schedule will begin running. The return value can be evaluated as one of the fields representing java.util.Calendar.MONTH field in java.util.Calendar, or 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 java.util.Calendar.MONTH field in java.util.Calendar, or ALL, which means every month in the year.

Parameters:

month - An int specifying the start month.

getStartDay

int getStartDay()

Returns the day on which the schedule will being running.

Returns:

An int specifying the start day.

setStartDay

void setStartDay(int day)

Sets the day on which 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 in which the schedule will stop running. The return value can be evaluated as one of the fields representing java.util.Calendar.MONTH field in java.util.Calendar, or 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 will stop running. The value can be evaluated as one of the fields representing java.util.Calendar.MONTH field in java.util.Calendar, or 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 will stop running.

Returns:

An int specifying the end day.

setEndDay

void setEndDay(int day)

Sets the day on which the schedule will stop running.

Parameters:

day - An int value representing the end day.

getWeekNumber

int getWeekNumber()

Returns 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. The default is 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. The default is 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 ALL meaning every week.

setDayOfWeek

void setDayOfWeek(int dayOfWeek)

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

Parameters:

dayOfWeek - An int representing the days of the week on which the job will be run, The value of the argument is evaluated as one of the fields representing java.util.Calendar.DAY_OF_WEEK in java.util.Calendar, or ALL, which means everyday of the week.

getDayOfWeek

int getDayOfWeek()

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

Returns:

An int specifying the days of the week on which the job will be run. The return type can also be evaluated as one of the fields representing java.util.Calendar.DAY_OF_WEEK in java.util.Calendar, or ALL, which means everyday of the week.