microsoft.exchange.webservices.data
Class Recurrence.RelativeMonthlyPattern

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

Enclosing class:

Recurrence

public static final class Recurrence.RelativeMonthlyPattern
extends Recurrence.IntervalPattern

Represents a recurrence pattern where each occurrence happens on a relative day a specific number of months 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.RelativeMonthlyPattern()
Instantiates a new relative monthly pattern.

Recurrence.RelativeMonthlyPattern(Date startDate, int interval, DayOfTheWeek dayOfTheWeek, DayOfTheWeekIndex dayOfTheWeekIndex)
Instantiates a new relative monthly pattern.

Method Summary

DayOfTheWeek	getDayOfTheWeek() Gets the day of the week.
DayOfTheWeekIndex	getDayOfTheWeekIndex() Day of the week index.
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	setDayOfTheWeek(DayOfTheWeek value) Sets the day of the week.
void	setDayOfTheWeekIndex(DayOfTheWeekIndex value) Day of the week index.
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.RelativeMonthlyPattern

public Recurrence.RelativeMonthlyPattern()

Instantiates a new relative monthly pattern.

Recurrence.RelativeMonthlyPattern

public Recurrence.RelativeMonthlyPattern(Date startDate,
                                         int interval,
                                         DayOfTheWeek dayOfTheWeek,
                                         DayOfTheWeekIndex dayOfTheWeekIndex)
                                  throws ArgumentOutOfRangeException

Instantiates a new relative monthly pattern.

Parameters:

startDate - the start date

interval - the interval

dayOfTheWeek - the day of the week

dayOfTheWeekIndex - the day of the week index

Throws:

ArgumentOutOfRangeException - the argument out of range exception

Method Detail

getXmlElementName

protected String getXmlElementName()

Gets 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

getDayOfTheWeekIndex

public DayOfTheWeekIndex getDayOfTheWeekIndex()
                                       throws ServiceValidationException

Day of the week index.

Returns:

the day of the week index

Throws:

ServiceValidationException - the service validation exception

setDayOfTheWeekIndex

public void setDayOfTheWeekIndex(DayOfTheWeekIndex value)

Day of the week index.

Parameters:

value - the value

getDayOfTheWeek

public DayOfTheWeek getDayOfTheWeek()
                             throws ServiceValidationException

Gets the day of the week.

Returns:

the day of the week

Throws:

ServiceValidationException - the service validation exception

setDayOfTheWeek

public void setDayOfTheWeek(DayOfTheWeek value)

Sets the day of the week.

Parameters:

value - the new day of the week