|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectmicrosoft.exchange.webservices.data.PropertySet
public final class PropertySet
Represents a set of item or folder properties. Property sets are used to indicate what properties of an item or folder should be loaded when binding to an existing item or folder or when loading an item or folder's properties.
Field Summary | |
---|---|
static PropertySet |
FirstClassProperties
The Constant FirstClassProperties. |
static PropertySet |
IdOnly
The Constant IdOnly. |
Constructor Summary | |
---|---|
PropertySet()
Initializes a new instance of PropertySet based upon BasePropertySet.IdOnly. |
|
PropertySet(BasePropertySet basePropertySet)
Initializes a new instance of PropertySet. |
|
PropertySet(BasePropertySet basePropertySet,
java.util.Iterator<PropertyDefinitionBase> additionalProperties)
Initializes a new instance of PropertySet. |
|
PropertySet(BasePropertySet basePropertySet,
PropertyDefinitionBase... additionalProperties)
Initializes a new instance of PropertySet. |
|
PropertySet(java.util.Iterator<PropertyDefinitionBase> additionalProperties)
Initializes a new instance of PropertySet based upon BasePropertySet.IdOnly. |
|
PropertySet(PropertyDefinitionBase... additionalProperties)
Initializes a new instance of PropertySet based upon BasePropertySet.IdOnly. |
Method Summary | |
---|---|
void |
add(PropertyDefinitionBase property)
* Adds the specified property to the property set. |
void |
addRange(java.lang.Iterable<PropertyDefinitionBase> properties)
* Adds the specified properties to the property set. |
void |
clear()
Remove all explicitly added properties from the property set. |
boolean |
contains(PropertyDefinitionBase property)
Determines whether the specified property has been explicitly added to this property set using the Add or AddRange methods. |
BasePropertySet |
getBasePropertySet()
* Gets the base property set, the property set is based upon. |
java.lang.Boolean |
getConvertHtmlCodePageToUTF8()
Gets value indicating whether or not to convert HTML code page to UTF8 encoding. |
int |
getCount()
* Gets the number of explicitly added properties in this set. |
static microsoft.exchange.webservices.data.LazyMember<java.util.Map<BasePropertySet,java.lang.String>> |
getDefaultPropertySetMap()
*Maps BasePropertySet values to EWS's BaseShape values. |
java.lang.Boolean |
getFilterHtmlContent()
* Gets value indicating whether or not to filter potentially unsafe HTML content from message bodies. |
static PropertySet |
getFirstClassProperties()
Returns a predefined property set that includes the first class properties of an item or folder. |
PropertyDefinitionBase |
getPropertyDefinitionBaseAt(int index)
* Gets the PropertyDefinitionBase at the specified index. |
static PropertySet |
getPropertySetFromBasePropertySet(BasePropertySet basePropertySet)
Implements an implicit conversion between PropertySet and BasePropertySet. |
BodyType |
getRequestedBodyType()
* Gets type of body that should be loaded on items. |
protected void |
internalValidate()
* Validates this property set. |
java.util.Iterator<PropertyDefinitionBase> |
iterator()
|
boolean |
remove(PropertyDefinitionBase property)
Removes the specified property from the set. |
void |
setBasePropertySet(BasePropertySet basePropertySet)
Sets the base property set, the property set is based upon. |
void |
setConvertHtmlCodePageToUTF8(java.lang.Boolean value)
Sets value indicating whether or not to convert HTML code page to UTF8 encoding. |
void |
setFilterHtmlContent(java.lang.Boolean filterHtml)
Sets value indicating whether or not to filter potentially unsafe HTML content from message bodies. |
void |
setRequestedBodyType(BodyType requestedBodyType)
Sets type of body that should be loaded on items. |
void |
validate()
Validate. |
protected void |
validateForRequest(microsoft.exchange.webservices.data.ServiceRequestBase request,
boolean summaryPropertiesOnly)
* Validates this property set instance for request to ensure that: 1. |
protected static void |
writeAdditionalPropertiesToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer,
java.util.Iterator<PropertyDefinitionBase> propertyDefinitions)
* Writes additonal properties to XML. |
protected void |
writeToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer,
ServiceObjectType serviceObjectType)
* Writes the property set to XML. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final PropertySet IdOnly
public static final PropertySet FirstClassProperties
Constructor Detail |
---|
public PropertySet(BasePropertySet basePropertySet, PropertyDefinitionBase... additionalProperties)
basePropertySet
- The base property set to base the property set upon.additionalProperties
- Additional properties to include in the property set. Property
definitions are available as static members from schema
classes (for example, EmailMessageSchema.Subject,
AppointmentSchema.Start, ContactSchema.GivenName, etc.)public PropertySet(BasePropertySet basePropertySet, java.util.Iterator<PropertyDefinitionBase> additionalProperties)
basePropertySet
- The base property set to base the property set upon.additionalProperties
- Additional properties to include in the property set. Property
definitions are available as static members from schema
classes (for example, EmailMessageSchema.Subject,
AppointmentSchema.Start, ContactSchema.GivenName, etc.)public PropertySet()
public PropertySet(BasePropertySet basePropertySet)
basePropertySet
- The base property set to base the property set upon.public PropertySet(PropertyDefinitionBase... additionalProperties)
additionalProperties
- Additional properties to include in the property set. Property
definitions are available as static members from schema
classes (for example, EmailMessageSchema.Subject,
AppointmentSchema.Start, ContactSchema.GivenName, etc.)public PropertySet(java.util.Iterator<PropertyDefinitionBase> additionalProperties)
additionalProperties
- Additional properties to include in the property set. Property
definitions are available as static members from schema
classes (for example, EmailMessageSchema.Subject,
AppointmentSchema.Start, ContactSchema.GivenName, etc.)Method Detail |
---|
public static PropertySet getFirstClassProperties()
public static PropertySet getPropertySetFromBasePropertySet(BasePropertySet basePropertySet)
basePropertySet
- The BasePropertySet value to convert from.
public void add(PropertyDefinitionBase property) throws java.lang.Exception
property
- The property to add.
java.lang.Exception
- the exceptionpublic void addRange(java.lang.Iterable<PropertyDefinitionBase> properties) throws java.lang.Exception
properties
- The properties to add.
java.lang.Exception
- the exceptionpublic void clear()
public boolean contains(PropertyDefinitionBase property)
property
- The property.
public boolean remove(PropertyDefinitionBase property)
property
- The property to remove.
public BasePropertySet getBasePropertySet()
public static microsoft.exchange.webservices.data.LazyMember<java.util.Map<BasePropertySet,java.lang.String>> getDefaultPropertySetMap()
public void setBasePropertySet(BasePropertySet basePropertySet)
basePropertySet
- Base property set.public BodyType getRequestedBodyType()
public void setRequestedBodyType(BodyType requestedBodyType)
requestedBodyType
- Type of body that should be loaded on items.public int getCount()
public java.lang.Boolean getFilterHtmlContent()
public void setFilterHtmlContent(java.lang.Boolean filterHtml)
filterHtml
- true to filter otherwise false.public java.lang.Boolean getConvertHtmlCodePageToUTF8()
public void setConvertHtmlCodePageToUTF8(java.lang.Boolean value)
public PropertyDefinitionBase getPropertyDefinitionBaseAt(int index)
index
- Index.
public void validate() throws ServiceValidationException
ServiceValidationException
- the service validation exceptionprotected static void writeAdditionalPropertiesToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer, java.util.Iterator<PropertyDefinitionBase> propertyDefinitions) throws javax.xml.stream.XMLStreamException, ServiceXmlSerializationException
writer
- The writer to write to.propertyDefinitions
- The property definitions to write.
javax.xml.stream.XMLStreamException
- the xML stream exception
ServiceXmlSerializationException
- the service xml serialization exceptionprotected void internalValidate() throws ServiceValidationException
ServiceValidationException
- the service validation exceptionprotected void validateForRequest(microsoft.exchange.webservices.data.ServiceRequestBase request, boolean summaryPropertiesOnly) throws ServiceVersionException, ServiceValidationException
request
- The request.summaryPropertiesOnly
- if set to true then only summary properties are allowed.
ServiceVersionException
- the service version exception
ServiceValidationException
- the service validation exceptionprotected void writeToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer, ServiceObjectType serviceObjectType) throws javax.xml.stream.XMLStreamException, ServiceXmlSerializationException
writer
- The writer to write to.serviceObjectType
- The type of service object the property set is emitted for.
javax.xml.stream.XMLStreamException
- the xML stream exception
ServiceXmlSerializationException
- the service xml serialization exceptionpublic java.util.Iterator<PropertyDefinitionBase> iterator()
iterator
in interface java.lang.Iterable<PropertyDefinitionBase>
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |