microsoft.exchange.webservices.data
Class Recurrence.YearlyPattern

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

Enclosing class:

Recurrence

public static final class Recurrence.YearlyPattern
extends Recurrence

Represents a recurrence pattern where each occurrence happens on a specific day every year.

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.YearlyPattern()
Initializes a new instance of the YearlyPattern class.

Recurrence.YearlyPattern(Date startDate, Month month, int dayOfMonth)
Initializes a new instance of the YearlyPattern class.

Method Summary

int	getDayOfMonth() Gets the day of the month when each occurrence happens.
Month	getMonth() Gets the month of the year when each occurrence happens.
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	setDayOfMonth(int value) Sets the day of the month when each occurrence happens.
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.YearlyPattern

public Recurrence.YearlyPattern()

Initializes a new instance of the YearlyPattern class.

Recurrence.YearlyPattern

public Recurrence.YearlyPattern(Date startDate,
                                Month month,
                                int dayOfMonth)

Initializes a new instance of the YearlyPattern class.

Parameters:

startDate - the start date

month - the month

dayOfMonth - the day of month

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

getMonth

public Month getMonth()
               throws ServiceValidationException

Gets the month of the year when each occurrence happens.

Returns:

the month

Throws:

ServiceValidationException - the service validation exception

setMonth

public void setMonth(Month value)

Sets the month.

Parameters:

value - the new month

getDayOfMonth

public int getDayOfMonth()
                  throws ServiceValidationException

Gets the day of the month when each occurrence happens. DayOfMonth must be between 1 and 31.

Returns:

the day of month

Throws:

ServiceValidationException - the service validation exception

setDayOfMonth

public void setDayOfMonth(int value)
                   throws ArgumentOutOfRangeException

Sets the day of the month when each occurrence happens. DayOfMonth must be between 1 and 31.

Parameters:

value - the new day of month

Throws:

ArgumentOutOfRangeException - the argument out of range exception