microsoft.exchange.webservices.data
Class Recurrence.WeeklyPattern

java.lang.Object
  microsoft.exchange.webservices.data.ComplexProperty
      microsoft.exchange.webservices.data.Recurrence
          microsoft.exchange.webservices.data.Recurrence.IntervalPattern
              microsoft.exchange.webservices.data.Recurrence.WeeklyPattern

Enclosing class:

Recurrence

public static final class Recurrence.WeeklyPattern
extends Recurrence.IntervalPattern

Represents a recurrence pattern where each occurrence happens on specific days a specific number of weeks after the previous one.

Nested Class Summary

Nested classes/interfaces inherited from class microsoft.exchange.webservices.data.Recurrence

Recurrence.DailyPattern, Recurrence.DailyRegenerationPattern, Recurrence.IntervalPattern, Recurrence.MonthlyPattern, Recurrence.MonthlyRegenerationPattern, Recurrence.RelativeMonthlyPattern, Recurrence.RelativeYearlyPattern, Recurrence.WeeklyPattern, Recurrence.WeeklyRegenerationPattern, Recurrence.YearlyPattern, Recurrence.YearlyRegenerationPattern

Constructor Summary

Recurrence.WeeklyPattern()
Initializes a new instance of the WeeklyPattern class.

Recurrence.WeeklyPattern(Date startDate, int interval, DayOfTheWeek... daysOfTheWeek)
Initializes a new instance of the WeeklyPattern class.

Method Summary

void	complexPropertyChanged(ComplexProperty complexProperty) Complex property changed.
DayOfTheWeekCollection	getDaysOfTheWeek() Gets the list of the days of the week when occurrences happen.
Calendar	getFirstDayOfWeek()
protected String	getXmlElementName() Gets the name of the XML element.
protected void	internalValidate() Validates this instance.
protected void	internalWritePropertiesToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer) Write properties to XML.
void	setFirstDayOfWeek(Calendar value)
protected boolean	tryReadElementFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader) Tries to read element from XML.

Methods inherited from class microsoft.exchange.webservices.data.Recurrence.IntervalPattern

getInterval, setInterval

Methods inherited from class microsoft.exchange.webservices.data.Recurrence

getEndDate, getFieldValueOrThrowIfNull, getNumberOfOccurrences, getStartDate, hasEnd, isRegenerationPattern, neverEnds, setEndDate, setNumberOfOccurrences, setStartDate, writeElementsToXml

Methods inherited from class microsoft.exchange.webservices.data.ComplexProperty

addOnChangeEvent, canSetFieldValue, changed, clearChangeEvents, clearChangeLog, getNamespace, loadFromXml, loadFromXml, readAttributesFromXml, readTextValueFromXml, removeChangeEvent, setNamespace, validate, writeAttributesToXml, writeToXml, writeToXml

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Recurrence.WeeklyPattern

public Recurrence.WeeklyPattern()

Initializes a new instance of the WeeklyPattern class. specific days a specific number of weeks after the previous one.

Recurrence.WeeklyPattern

public Recurrence.WeeklyPattern(Date startDate,
                                int interval,
                                DayOfTheWeek... daysOfTheWeek)
                         throws ArgumentOutOfRangeException

Initializes a new instance of the WeeklyPattern class.

Parameters:

startDate - the start date

interval - the interval

daysOfTheWeek - the days of the week

Throws:

ArgumentOutOfRangeException - the argument out of range exception

Method Detail

getXmlElementName

protected String getXmlElementName()

Gets the name of the XML element. The name of the XML element.

Specified by:

getXmlElementName in class Recurrence

Returns:

the xml element name

internalWritePropertiesToXml

protected void internalWritePropertiesToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
                                     throws Exception

Write properties to XML.

Overrides:

internalWritePropertiesToXml in class Recurrence.IntervalPattern

Parameters:

writer - the writer

Throws:

Exception - the exception

tryReadElementFromXml

protected boolean tryReadElementFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
                                 throws Exception

Tries to read element from XML.

Overrides:

tryReadElementFromXml in class Recurrence.IntervalPattern

Parameters:

reader - the reader

Returns:

True if appropriate element was read.

Throws:

Exception - the exception

internalValidate

protected void internalValidate()
                         throws Exception

Validates this instance.

Overrides:

internalValidate in class Recurrence

Throws:

Exception

ServiceValidationException - the service validation exception

getDaysOfTheWeek

public DayOfTheWeekCollection getDaysOfTheWeek()

Gets the list of the days of the week when occurrences happen.

Returns:

the days of the week

getFirstDayOfWeek

public Calendar getFirstDayOfWeek()
                           throws ServiceValidationException

Throws:

ServiceValidationException

setFirstDayOfWeek

public void setFirstDayOfWeek(Calendar value)

complexPropertyChanged

public void complexPropertyChanged(ComplexProperty complexProperty)

Complex property changed.

Parameters:

complexProperty - the complex property