microsoft.exchange.webservices.data
Class ComplexProperty

java.lang.Object
  extended by microsoft.exchange.webservices.data.ComplexProperty
Direct Known Subclasses:
Attachment, ByteArrayArray, CalendarEvent, CalendarEventDetails, CompleteName, ComplexPropertyCollection, Conflict, DayOfTheWeekCollection, DelegatePermissions, DelegateUser, DeletedOccurrenceInfo, DictionaryEntryProperty, DictionaryProperty, EmailAddress, ExtendedProperty, FolderPermission, GroupMember, InternetMessageHeader, ItemCollection, Mailbox, ManagedFolderInformation, MessageBody, MimeContent, OccurrenceInfo, OofSettings, PhoneCall, Recurrence, Rule, RuleActions, RuleCollection, RuleError, RuleOperation, RuleOperationError, RulePredicateDateRange, RulePredicates, RulePredicateSizeRange, SearchFilter, SearchFolderParameters, ServiceId, StringList, Suggestion, TimeSuggestion, TimeZoneDefinition, UniqueBody, UserConfigurationDictionary, UserId, WorkingHours

public abstract class ComplexProperty
extends java.lang.Object

Represents a property that can be sent to or retrieved from EWS.


Constructor Summary
protected ComplexProperty()
          * Initializes a new instance.
 
Method Summary
protected  void addOnChangeEvent(microsoft.exchange.webservices.data.IComplexPropertyChangedDelegate change)
          Set event to happen when property changed.
protected
<T> boolean
canSetFieldValue(T field, T value)
          * Sets value of field.
protected  void changed()
          Instance was changed.
protected  void clearChangeEvents()
          * Clears change events list.
protected  void clearChangeLog()
          Clears the change log.
 java.lang.Boolean func(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
           
protected  microsoft.exchange.webservices.data.XmlNamespace getNamespace()
          Gets the namespace.
protected  void internalValidate()
          * Validates this instance.
protected  void loadFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader, java.lang.String xmlElementName)
          * Loads from XML.
protected  void loadFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader, microsoft.exchange.webservices.data.XmlNamespace xmlNamespace, java.lang.String xmlElementName)
          * Loads from XML.
protected  void readAttributesFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
          * Reads the attributes from XML.
protected  void readTextValueFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
          * Reads the text value from XML.
protected  void removeChangeEvent(microsoft.exchange.webservices.data.IComplexPropertyChangedDelegate change)
          Remove the event from happening when property changed.
protected  void setNamespace(microsoft.exchange.webservices.data.XmlNamespace xmlNamespace)
          Sets the namespace.
protected  boolean tryReadElementFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
          * Tries to read element from XML.
protected  boolean tryReadElementFromXmlToPatch(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
          Tries to read element from XML to patch this property.
protected  void updateFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader, java.lang.String xmlElementName)
          Loads from XML to update this property.
protected  void updateFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader, microsoft.exchange.webservices.data.XmlNamespace xmlNamespace, java.lang.String xmlElementName)
          Loads from XML to update itself.
 void validate()
          * Implements ISelfValidate.validate.
protected  void writeAttributesToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
          * Writes the attributes to XML.
protected  void writeElementsToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
          * Writes elements to XML.
protected  void writeToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer, java.lang.String xmlElementName)
          * Writes to XML.
protected  void writeToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer, microsoft.exchange.webservices.data.XmlNamespace xmlNamespace, java.lang.String xmlElementName)
          * Writes to XML.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ComplexProperty

protected ComplexProperty()
* Initializes a new instance.

Method Detail

getNamespace

protected microsoft.exchange.webservices.data.XmlNamespace getNamespace()
Gets the namespace.

Returns:
the namespace.

setNamespace

protected void setNamespace(microsoft.exchange.webservices.data.XmlNamespace xmlNamespace)
Sets the namespace.

Parameters:
xmlNamespace - the namespace.

changed

protected void changed()
Instance was changed.


canSetFieldValue

protected <T> boolean canSetFieldValue(T field,
                                       T value)
* Sets value of field.

Type Parameters:
T - Field type.
Parameters:
field - The field.
value - The value.
Returns:
true, if successful

clearChangeLog

protected void clearChangeLog()
Clears the change log.


readAttributesFromXml

protected void readAttributesFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
                              throws java.lang.Exception
* Reads the attributes from XML.

Parameters:
reader - The reader.
Throws:
java.lang.Exception - the exception

readTextValueFromXml

protected void readTextValueFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
                             throws java.lang.Exception
* Reads the text value from XML.

Parameters:
reader - The reader.
Throws:
java.lang.Exception - the exception

tryReadElementFromXml

protected boolean tryReadElementFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
                                 throws java.lang.Exception
* Tries to read element from XML.

Parameters:
reader - The reader.
Returns:
True if element was read.
Throws:
java.lang.Exception - the exception

tryReadElementFromXmlToPatch

protected boolean tryReadElementFromXmlToPatch(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
                                        throws java.lang.Exception
Tries to read element from XML to patch this property.

Parameters:
reader - The reader. True if element was read.
Throws:
java.lang.Exception

writeAttributesToXml

protected void writeAttributesToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
                             throws ServiceXmlSerializationException
* Writes the attributes to XML.

Parameters:
writer - The writer.
Throws:
ServiceXmlSerializationException - the service xml serialization exception

writeElementsToXml

protected void writeElementsToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
                           throws java.lang.Exception
* Writes elements to XML.

Parameters:
writer - The writer.
Throws:
java.lang.Exception - the exception

loadFromXml

protected void loadFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader,
                           microsoft.exchange.webservices.data.XmlNamespace xmlNamespace,
                           java.lang.String xmlElementName)
                    throws java.lang.Exception
* Loads from XML.

Parameters:
reader - The reader.
xmlNamespace - the xml namespace
xmlElementName - Name of the XML element.
Throws:
java.lang.Exception - the exception

updateFromXml

protected void updateFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader,
                             java.lang.String xmlElementName)
                      throws java.lang.Exception
Loads from XML to update this property.

Parameters:
reader - The reader.
xmlElementName - Name of the XML element.
Throws:
java.lang.Exception

updateFromXml

protected void updateFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader,
                             microsoft.exchange.webservices.data.XmlNamespace xmlNamespace,
                             java.lang.String xmlElementName)
                      throws java.lang.Exception
Loads from XML to update itself.

Parameters:
reader - The reader.
xmlNamespace - The XML namespace.
xmlElementName - Name of the XML element.
complexFunctionDelegate -
Throws:
java.lang.Exception

loadFromXml

protected void loadFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader,
                           java.lang.String xmlElementName)
                    throws java.lang.Exception
* Loads from XML.

Parameters:
reader - The reader.
xmlElementName - Name of the XML element.
Throws:
java.lang.Exception - the exception

writeToXml

protected void writeToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer,
                          microsoft.exchange.webservices.data.XmlNamespace xmlNamespace,
                          java.lang.String xmlElementName)
                   throws java.lang.Exception
* Writes to XML.

Parameters:
writer - The writer.
xmlNamespace - The XML namespace.
xmlElementName - Name of the XML element.
Throws:
java.lang.Exception - the exception

writeToXml

protected void writeToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer,
                          java.lang.String xmlElementName)
                   throws java.lang.Exception
* Writes to XML.

Parameters:
writer - The writer.
xmlElementName - Name of the XML element.
Throws:
java.lang.Exception - the exception

addOnChangeEvent

protected void addOnChangeEvent(microsoft.exchange.webservices.data.IComplexPropertyChangedDelegate change)
Set event to happen when property changed.

Parameters:
change - change event

removeChangeEvent

protected void removeChangeEvent(microsoft.exchange.webservices.data.IComplexPropertyChangedDelegate change)
Remove the event from happening when property changed.

Parameters:
change - change event

clearChangeEvents

protected void clearChangeEvents()
* Clears change events list.


validate

public void validate()
              throws ServiceValidationException,
                     java.lang.Exception
* Implements ISelfValidate.validate. Validates this instance.

Throws:
ServiceValidationException - the service validation exception
java.lang.Exception - the exception

internalValidate

protected void internalValidate()
                         throws ServiceValidationException,
                                java.lang.Exception
* Validates this instance.

Throws:
ServiceValidationException - the service validation exception
java.lang.Exception

func

public java.lang.Boolean func(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
                       throws java.lang.Exception
Throws:
java.lang.Exception