|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectmicrosoft.exchange.webservices.data.ServiceObject
public abstract class ServiceObject
Represents the base abstract class for all item and folder types.
Constructor Summary | |
---|---|
protected |
ServiceObject(ExchangeService service)
Internal constructor. |
Method Summary | ||
---|---|---|
void |
addServiceObjectChangedEvent(microsoft.exchange.webservices.data.IServiceObjectChangedDelegate change)
Adds the service object changed event. |
|
protected void |
changed()
Triggers dispatch of the change event. |
|
protected void |
clearChangeLog()
Clear change log. |
|
void |
clearServiceObjectChangedEvent()
Clear service object changed event. |
|
protected java.lang.String |
getChangeXmlElementName()
Gets the name of the change XML element. |
|
protected java.lang.String |
getDeleteFieldXmlElementName()
Gets the name of the delete field XML element. |
|
protected ExtendedPropertyCollection |
getExtendedProperties()
Gets the extended properties. |
|
protected ServiceId |
getId()
Gets the id. |
|
protected PropertyDefinition |
getIdPropertyDefinition()
Gets the id property definition. |
|
protected boolean |
getIsCustomDateTimeScopingRequired()
Determines whether properties defined with ScopedDateTimePropertyDefinition require custom time zone scoping. |
|
protected boolean |
getIsTimeZoneHeaderRequired(boolean isUpdateOperation)
Gets a value indicating whether a time zone SOAP header should be emitted in a CreateItem or UpdateItem request so this item can be property saved or updated. |
|
java.util.Collection<PropertyDefinitionBase> |
getLoadedPropertyDefinitions()
Gets the collection of loaded property definitions. |
|
protected abstract ExchangeVersion |
getMinimumRequiredServerVersion()
Gets the minimum required server version. |
|
java.lang.Object |
getObjectFromPropertyDefinition(PropertyDefinitionBase propertyDefinition)
* Gets the value of specified property in this instance. |
|
protected microsoft.exchange.webservices.data.PropertyBag |
getPropertyBag()
The property bag holding property values for this object. |
|
protected abstract ServiceObjectSchema |
getSchema()
Internal method to return the schema associated with this type of object. |
|
ExchangeService |
getService()
Gets the service. |
|
protected java.lang.String |
getSetFieldXmlElementName()
Gets the name of the set field XML element. |
|
protected java.lang.String |
getXmlElementName()
GetXmlElementName retrieves the XmlElementName of this type based on the EwsObjectDefinition attribute that decorates it, if present. |
|
protected java.lang.String |
getXmlElementNameOverride()
This methods lets subclasses of ServiceObject override the default mechanism by which the XML element name associated with their type is retrieved. |
|
protected abstract void |
internalDelete(DeleteMode deleteMode,
SendCancellationsMode sendCancellationsMode,
AffectedTaskOccurrence affectedTaskOccurrences)
Internal delete. |
|
protected abstract void |
internalLoad(PropertySet propertySet)
Internal load. |
|
boolean |
isDirty()
Checks if is dirty. |
|
boolean |
isNew()
Checks if is new. |
|
void |
load()
Load. |
|
void |
load(PropertySet propertySet)
Load. |
|
protected void |
loadFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader,
boolean clearPropertyBag)
Loads service object from XML. |
|
protected void |
loadFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader,
boolean clearPropertyBag,
PropertySet requestedPropertySet,
boolean summaryPropertiesOnly)
Load from xml. |
|
void |
removeServiceObjectChangedEvent(microsoft.exchange.webservices.data.IServiceObjectChangedDelegate change)
Removes the service object changed event. |
|
ServiceObjectSchema |
schema()
Gets the schema associated with this type of object. |
|
protected void |
setService(ExchangeService service)
Sets the service. |
|
protected void |
throwIfThisIsNew()
Throws exception if this is a new service object. |
|
protected void |
throwIfThisIsNotNew()
Throws exception if this is not a new service object. |
|
protected
|
tryGetExtendedProperty(java.lang.Class<T> cls,
ExtendedPropertyDefinition propertyDefinition,
OutParam<T> propertyValue)
Try to get the value of a specified extended property in this instance. |
|
|
tryGetProperty(java.lang.Class<T> cls,
PropertyDefinitionBase propertyDefinition,
OutParam<T> propertyValue)
Try to get the value of a specified property in this instance. |
|
boolean |
tryGetProperty(PropertyDefinitionBase propertyDefinition,
OutParam<java.lang.Object> propertyValue)
Try to get the value of a specified property in this instance. |
|
protected void |
validate()
Validate. |
|
protected void |
writeToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
Write to xml. |
|
protected void |
writeToXmlForUpdate(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
Write to xml for update. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected ServiceObject(ExchangeService service) throws java.lang.Exception
service
- the service
java.lang.Exception
- the exceptionMethod Detail |
---|
protected void changed()
protected void throwIfThisIsNew() throws InvalidOperationException, ServiceLocalException
InvalidOperationException
- the invalid operation exception
ServiceLocalException
- the service local exceptionprotected void throwIfThisIsNotNew() throws InvalidOperationException, ServiceLocalException
InvalidOperationException
- the invalid operation exception
ServiceLocalException
- the service local exceptionprotected java.lang.String getXmlElementNameOverride()
protected java.lang.String getXmlElementName()
protected java.lang.String getChangeXmlElementName()
protected java.lang.String getSetFieldXmlElementName()
protected java.lang.String getDeleteFieldXmlElementName()
protected boolean getIsTimeZoneHeaderRequired(boolean isUpdateOperation) throws ServiceLocalException, java.lang.Exception
isUpdateOperation
- the is update operation
ServiceLocalException
java.lang.Exception
protected boolean getIsCustomDateTimeScopingRequired()
protected microsoft.exchange.webservices.data.PropertyBag getPropertyBag()
public ServiceObjectSchema schema()
protected abstract ServiceObjectSchema getSchema()
protected abstract ExchangeVersion getMinimumRequiredServerVersion()
protected void loadFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader, boolean clearPropertyBag) throws java.lang.Exception
reader
- the readerclearPropertyBag
- the clear property bag
java.lang.Exception
- the exceptionprotected void validate() throws java.lang.Exception
java.lang.Exception
- the exceptionprotected void loadFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader, boolean clearPropertyBag, PropertySet requestedPropertySet, boolean summaryPropertiesOnly) throws java.lang.Exception
reader
- the readerclearPropertyBag
- the clear property bagrequestedPropertySet
- the requested property setsummaryPropertiesOnly
- the summary properties only
java.lang.Exception
- the exceptionprotected void clearChangeLog()
protected void writeToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer) throws java.lang.Exception
writer
- the writer
java.lang.Exception
- the exceptionprotected void writeToXmlForUpdate(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer) throws java.lang.Exception
writer
- the writer
java.lang.Exception
- the exceptionprotected abstract void internalLoad(PropertySet propertySet) throws java.lang.Exception
propertySet
- the property set
java.lang.Exception
- the exceptionprotected abstract void internalDelete(DeleteMode deleteMode, SendCancellationsMode sendCancellationsMode, AffectedTaskOccurrence affectedTaskOccurrences) throws java.lang.Exception
deleteMode
- the delete modesendCancellationsMode
- the send cancellations modeaffectedTaskOccurrences
- the affected task occurrences
java.lang.Exception
- the exceptionpublic void load(PropertySet propertySet) throws java.lang.Exception
propertySet
- the property set
java.lang.Exception
- the exceptionpublic void load() throws java.lang.Exception
java.lang.Exception
- the exceptionpublic java.lang.Object getObjectFromPropertyDefinition(PropertyDefinitionBase propertyDefinition) throws java.lang.Exception
propertyDefinition
- Definition of the property to get.
java.lang.Exception
- the exceptionprotected <T> boolean tryGetExtendedProperty(java.lang.Class<T> cls, ExtendedPropertyDefinition propertyDefinition, OutParam<T> propertyValue) throws java.lang.Exception
propertyDefinition
- the property definitionpropertyValue
- the property value
java.lang.Exception
- the exceptionpublic boolean tryGetProperty(PropertyDefinitionBase propertyDefinition, OutParam<java.lang.Object> propertyValue) throws java.lang.Exception
propertyDefinition
- The property definition.propertyValue
- The property value
java.lang.Exception
public <T> boolean tryGetProperty(java.lang.Class<T> cls, PropertyDefinitionBase propertyDefinition, OutParam<T> propertyValue) throws java.lang.Exception
propertyDefinition
- the property definitionpropertyValue
- the property value
java.lang.Exception
- the exceptionpublic java.util.Collection<PropertyDefinitionBase> getLoadedPropertyDefinitions() throws java.lang.Exception
java.lang.Exception
- the exceptionpublic ExchangeService getService()
protected void setService(ExchangeService service)
service
- the new serviceprotected PropertyDefinition getIdPropertyDefinition()
protected ServiceId getId() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic boolean isNew() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic boolean isDirty()
protected ExtendedPropertyCollection getExtendedProperties() throws java.lang.Exception
java.lang.Exception
- the exceptionpublic void addServiceObjectChangedEvent(microsoft.exchange.webservices.data.IServiceObjectChangedDelegate change)
change
- the changepublic void removeServiceObjectChangedEvent(microsoft.exchange.webservices.data.IServiceObjectChangedDelegate change)
change
- the changepublic void clearServiceObjectChangedEvent()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |