public class CalendarException extends Object
Represent exceptional time periods in a calendar.
Constructor and Description |
---|
CalendarException()
Initializes a new instance of the
CalendarException class. |
Modifier and Type | Method and Description |
---|---|
boolean |
checkException(Date dt)
Returns true if dt is the exception day
|
void |
delete()
Deletes the Exception instance from parent calendar CalendarExceptionCollection object.
|
DayTypeCollection |
getDaysOfWeek()
Returns DayTypeCollection for this object.
|
boolean |
getDayWorking()
Determines whether the specified date or day type is working.
|
boolean |
getEnteredByOccurrences()
Determines whether the range of recurrence is defined by entering a number of occurrences.
|
Date |
getFromDate()
Returns the beginning of the exception time.
|
int |
getMonth()
Returns the month for which an exception recurrence is scheduled.
|
int |
getMonthDay()
Returns the day of a month on which an exception recurrence is scheduled.
|
int |
getMonthItem()
Returns the month item for which an exception recurrence is scheduled.
|
int |
getMonthPosition()
Returns the position of a month item within a month.
|
String |
getName()
Returns the name of the exception.
|
int |
getOccurrences()
Returns the number of occurrences for which the calendar exception is valid.
|
Calendar |
getParentCalendar()
Returns parent calendar for this object.
|
int |
getPeriod()
Returns the period of recurrence for the exception.
|
Date |
getToDate()
Returns the end of the exception time.
|
int |
getType()
Returns the exception type.
|
double |
getWorkingTime()
Returns the working time for a calendar exception.
|
WorkingTimeCollection |
getWorkingTimes()
Returns the collection of working times that defines the time worked on the weekday.
|
void |
setDayWorking(boolean value)
Determines whether the specified date or day type is working.
|
void |
setEnteredByOccurrences(boolean value)
Determines whether the range of recurrence is defined by entering a number of occurrences.
|
void |
setFromDate(Date value)
Sets the beginning of the exception time.
|
void |
setMonth(int value)
Sets the month for which an exception recurrence is scheduled.
|
void |
setMonthDay(int value)
Sets the day of a month on which an exception recurrence is scheduled.
|
void |
setMonthItem(int value)
Sets the month item for which an exception recurrence is scheduled.
|
void |
setMonthPosition(int value)
Sets the position of a month item within a month.
|
void |
setName(String value)
Sets the name of the exception.
|
void |
setOccurrences(int value)
Sets the number of occurrences for which the calendar exception is valid.
|
void |
setPeriod(int value)
Sets the period of recurrence for the exception.
|
void |
setToDate(Date value)
Sets the end of the exception time.
|
void |
setType(int value)
Sets the exception type.
|
void |
setWorkingTimes(WorkingTimeCollection value)
Sets the collection of working times that defines the time worked on the weekday.
|
public CalendarException()
Initializes a new instance of the CalendarException
class.
public boolean checkException(Date dt)
Returns true if dt is the exception day
dt
- date to check exception for.public void delete()
Deletes the Exception instance from parent calendar CalendarExceptionCollection object.
public boolean getDayWorking()
Determines whether the specified date or day type is working.
Read/write boolean
.
public void setDayWorking(boolean value)
Determines whether the specified date or day type is working.
Read/write boolean
.
value
- true if the specified date or day type is working.public DayTypeCollection getDaysOfWeek()
Returns DayTypeCollection for this object.
The days of the week on which the exception is valid.
Read only DayTypeCollection
instance.
public boolean getEnteredByOccurrences()
Determines whether the range of recurrence is defined by entering a number of occurrences.
False specifies that the range of recurrence is defined by entering a finish date.
Read/write boolean
.
public void setEnteredByOccurrences(boolean value)
Determines whether the range of recurrence is defined by entering a number of occurrences.
False specifies that the range of recurrence is defined by entering a finish date.
Read/write boolean
.
value
- true if the range of recurrence is defined by entering a number of occurrences.public Date getFromDate()
Returns the beginning of the exception time.
Read/write Date
.
public void setFromDate(Date value)
Sets the beginning of the exception time.
Read/write Date
.
value
- from date.public int getMonth()
Returns the month for which an exception recurrence is scheduled.
Read/write Month
.
public void setMonth(int value)
Sets the month for which an exception recurrence is scheduled.
Read/write Month
.
value
- exception month.public int getMonthDay()
Returns the day of a month on which an exception recurrence is scheduled.
Read/write int
.
public void setMonthDay(int value)
Sets the day of a month on which an exception recurrence is scheduled.
Read/write int
.
value
- exception month day.public int getMonthItem()
Returns the month item for which an exception recurrence is scheduled.
Read/write MonthItemType
.
public void setMonthItem(int value)
value
- exception month item.public int getMonthPosition()
Returns the position of a month item within a month.
Read/write MonthPosition
.
public void setMonthPosition(int value)
Sets the position of a month item within a month.
Read/write MonthPosition
.
value
- exception month position.public String getName()
Returns the name of the exception.
Read/write String
.
public void setName(String value)
Sets the name of the exception.
Read/write String
.
value
- exception name.public int getOccurrences()
Returns the number of occurrences for which the calendar exception is valid.
Read/write int
.
public void setOccurrences(int value)
Sets the number of occurrences for which the calendar exception is valid.
Read/write int
.
value
- the number of occurrences for which the calendar exception is valid.public Calendar getParentCalendar()
Returns parent calendar for this object.
Read only Calendar
.
public int getPeriod()
Returns the period of recurrence for the exception.
Read/write int
.
public void setPeriod(int value)
Sets the period of recurrence for the exception.
Read/write int
.
value
- exception period.public Date getToDate()
Returns the end of the exception time.
Read/write Date
.
public void setToDate(Date value)
Sets the end of the exception time.
Read/write Date
.
value
- exception time end.public int getType()
Returns the exception type.
Read/write CalendarExceptionType
.
public void setType(int value)
Sets the exception type.
Read/write CalendarExceptionType
.
value
- exception type.public double getWorkingTime()
Returns the working time for a calendar exception.
public WorkingTimeCollection getWorkingTimes()
Returns the collection of working times that defines the time worked on the weekday.
Read only WorkingTimeCollection
instance.
At least one working time must present, and there can't be more than five.
public void setWorkingTimes(WorkingTimeCollection value)
value
- the collection of working times that defines the time worked on the weekday.Copyright (c) 2008-2018 Aspose Pty Ltd. All Rights Reserved.