microsoft.exchange.webservices.data
Class Recurrence.RelativeYearlyPattern

java.lang.Object
  microsoft.exchange.webservices.data.ComplexProperty
      microsoft.exchange.webservices.data.Recurrence
          microsoft.exchange.webservices.data.Recurrence.RelativeYearlyPattern

Enclosing class:

Recurrence

public static final class Recurrence.RelativeYearlyPattern
extends Recurrence

The Class RelativeYearlyPattern.

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.RelativeYearlyPattern()
Instantiates a new relative yearly pattern.

Recurrence.RelativeYearlyPattern(Date startDate, Month month, DayOfTheWeek dayOfTheWeek, DayOfTheWeekIndex dayOfTheWeekIndex)
Instantiates a new relative yearly pattern.

Method Summary

DayOfTheWeek	getDayOfTheWeek() Gets the day of the week.
DayOfTheWeekIndex	getDayOfTheWeekIndex() Gets the relative position of the day specified in DayOfTheWeek within the month.
Month	getMonth() Gets the month.
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) Sets the relative position of the day specified in DayOfTheWeek within the month.
void	setMonth(Month value) Sets the month.
protected boolean	tryReadElementFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader) Tries to read element from XML.

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.RelativeYearlyPattern

public Recurrence.RelativeYearlyPattern()

Instantiates a new relative yearly pattern.

Recurrence.RelativeYearlyPattern

public Recurrence.RelativeYearlyPattern(Date startDate,
                                        Month month,
                                        DayOfTheWeek dayOfTheWeek,
                                        DayOfTheWeekIndex dayOfTheWeekIndex)

Instantiates a new relative yearly pattern.

Parameters:

startDate - the start date

month - the month

dayOfTheWeek - the day of the week

dayOfTheWeekIndex - the day of the week index

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

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 ComplexProperty

Parameters:

reader - the reader

Returns:

True if 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

Gets the relative position of the day specified in DayOfTheWeek within the month.

Returns:

the day of the week index

Throws:

ServiceValidationException - the service validation exception

setDayOfTheWeekIndex

public void setDayOfTheWeekIndex(DayOfTheWeekIndex value)

Sets the relative position of the day specified in DayOfTheWeek within the month.

Parameters:

value - the new day of the week index

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

getMonth

public Month getMonth()
               throws ServiceValidationException

Gets the month.

Returns:

the month

Throws:

ServiceValidationException - the service validation exception

setMonth

public void setMonth(Month value)

Sets the month.

Parameters:

value - the new month