Class Recurrence.YearlyPattern
- java.lang.Object
-
- microsoft.exchange.webservices.data.property.complex.ComplexProperty
-
- microsoft.exchange.webservices.data.property.complex.recurrence.pattern.Recurrence
-
- microsoft.exchange.webservices.data.property.complex.recurrence.pattern.Recurrence.YearlyPattern
-
- All Implemented Interfaces:
ISelfValidate,ComplexFunctionDelegate<EwsServiceXmlReader>
- 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.property.complex.recurrence.pattern.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
Constructors Constructor Description YearlyPattern()Initializes a new instance of the YearlyPattern class.YearlyPattern(Date startDate, Month month, int dayOfMonth)Initializes a new instance of the YearlyPattern class.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intgetDayOfMonth()Gets the day of the month when each occurrence happens.MonthgetMonth()Gets the month of the year when each occurrence happens.StringgetXmlElementName()Gets the name of the XML element.voidinternalValidate()Validates this instance.voidinternalWritePropertiesToXml(EwsServiceXmlWriter writer)Write property to XML.voidsetDayOfMonth(int value)Sets the day of the month when each occurrence happens.voidsetMonth(Month value)Sets the month.booleantryReadElementFromXml(EwsServiceXmlReader reader)Tries to read element from XML.-
Methods inherited from class microsoft.exchange.webservices.data.property.complex.recurrence.pattern.Recurrence
getEndDate, getFieldValueOrThrowIfNull, getNumberOfOccurrences, getStartDate, hasEnd, isRegenerationPattern, neverEnds, setEndDate, setNumberOfOccurrences, setStartDate, writeElementsToXml
-
Methods inherited from class microsoft.exchange.webservices.data.property.complex.ComplexProperty
addOnChangeEvent, canSetFieldValue, changed, clearChangeEvents, clearChangeLog, func, getNamespace, loadFromXml, loadFromXml, readAttributesFromXml, readTextValueFromXml, removeChangeEvent, setNamespace, tryReadElementFromXmlToPatch, updateFromXml, updateFromXml, validate, writeAttributesToXml, writeToXml, writeToXml
-
-
-
-
Constructor Detail
-
YearlyPattern
public YearlyPattern()
Initializes a new instance of the YearlyPattern class.
-
YearlyPattern
public YearlyPattern(Date startDate, Month month, int dayOfMonth)
Initializes a new instance of the YearlyPattern class.- Parameters:
startDate- the start datemonth- the monthdayOfMonth- the day of month
-
-
Method Detail
-
getXmlElementName
public String getXmlElementName()
Gets the name of the XML element.- Specified by:
getXmlElementNamein classRecurrence- Returns:
- the xml element name
-
internalWritePropertiesToXml
public void internalWritePropertiesToXml(EwsServiceXmlWriter writer) throws Exception
Write property to XML.- Overrides:
internalWritePropertiesToXmlin classRecurrence- Parameters:
writer- the writer- Throws:
Exception- the exception
-
tryReadElementFromXml
public boolean tryReadElementFromXml(EwsServiceXmlReader reader) throws Exception
Tries to read element from XML.- Overrides:
tryReadElementFromXmlin classComplexProperty- Parameters:
reader- the reader- Returns:
- True if element was read
- Throws:
Exception- the exception
-
internalValidate
public void internalValidate() throws Exception
Validates this instance.- Overrides:
internalValidatein classRecurrence- Throws:
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
-
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
-
-