microsoft.exchange.webservices.data
Class ContactGroup

java.lang.Object
  extended by microsoft.exchange.webservices.data.ServiceObject
      extended by microsoft.exchange.webservices.data.Item
          extended by microsoft.exchange.webservices.data.ContactGroup

public class ContactGroup
extends Item

Represents a Contact Group. Properties available on contact groups are defined in the ContactGroupSchema class.


Constructor Summary
  ContactGroup(ExchangeService service)
          Initializes an unsaved local instance of the class.
protected ContactGroup(ItemAttachment parentAttachment)
          Initializes an new instance of the class.
 
Method Summary
static ContactGroup bind(ExchangeService service, ItemId id)
          Binds to an existing contact group and loads the specified set of properties.Calling this method results in a call to EWS.
static ContactGroup bind(ExchangeService service, ItemId id, PropertySet propertySet)
          Binds to an existing contact group and loads the specified set of properties.Calling this method results in a call to EWS.
 java.lang.String getDisplayName()
          Gets the display name of the contact group.
 java.lang.String getFileAs()
          Gets the name under which this contact group is filed as.
 GroupMemberCollection getMembers()
          Gets the members of the contact group.
protected  ExchangeVersion getMinimumRequiredServerVersion()
          Gets the minimum required server version.
protected  ServiceObjectSchema getSchema()
          Internal method to return the schema associated with this type of object.
 void setDisplayName(java.lang.String value)
          Sets the display name.
protected  void setSubject(java.lang.String subject)
          Sets the subject.
 
Methods inherited from class microsoft.exchange.webservices.data.Item
copy, copy, delete, getAllowedResponseActions, getAttachments, getBody, getCategories, getConversationId, getCulture, getDateTimeCreated, getDateTimeReceived, getDateTimeSent, getDefaultAffectedTaskOccurrences, getDefaultSendCancellationsMode, getDefaultSendInvitationsMode, getDefaultSendInvitationsOrCancellationsMode, getDisplayCc, getDisplayTo, getEffectiveRights, getExtendedProperties, getHasAttachments, getId, getIdPropertyDefinition, getImportance, getInReplyTo, getInternetMessageHeaders, getIsAssociated, getIsDraft, getIsFromMe, getIsNew, getIsReminderSet, getIsResend, getIsSubmitted, getIsTimeZoneHeaderRequired, getIsUnmodified, getItemClass, getLastModifiedName, getLastModifiedTime, getMimeContent, getParentAttachment, getParentFolderId, getReminderDueBy, getReminderMinutesBeforeStart, getRootItemId, getSensitivity, getSize, getSubject, getUniqueBody, getWebClientEditFormQueryString, getWebClientReadFormQueryString, hasUnprocessedAttachmentChanges, internalCreate, internalDelete, internalLoad, internalUpdate, isAttachment, move, move, removeExtendedProperty, save, save, save, setBody, setCategories, setCulture, setExtendedProperty, setImportance, setInReplyTo, setIsReminderSet, setItemClass, setMimeContent, setReminderDueBy, setReminderMinutesBeforeStart, setSensitivity, setSubject, throwIfThisIsAttachment, update, validate
 
Methods inherited from class microsoft.exchange.webservices.data.ServiceObject
addServiceObjectChangedEvent, changed, clearChangeLog, clearServiceObjectChangedEvent, getChangeXmlElementName, getDeleteFieldXmlElementName, getIsCustomDateTimeScopingRequired, getLoadedPropertyDefinitions, getObjectFromPropertyDefinition, getPropertyBag, getService, getSetFieldXmlElementName, getXmlElementName, getXmlElementNameOverride, isDirty, isNew, load, load, loadFromXml, loadFromXml, removeServiceObjectChangedEvent, schema, setService, throwIfThisIsNew, throwIfThisIsNotNew, tryGetExtendedProperty, tryGetProperty, tryGetProperty, writeToXml, writeToXmlForUpdate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ContactGroup

public ContactGroup(ExchangeService service)
             throws java.lang.Exception
Initializes an unsaved local instance of the class.

Parameters:
service - the service
Throws:
java.lang.Exception - the exception

ContactGroup

protected ContactGroup(ItemAttachment parentAttachment)
                throws java.lang.Exception
Initializes an new instance of the class.

Parameters:
parentAttachment - the parent attachment
Throws:
java.lang.Exception - the exception
Method Detail

getFileAs

public java.lang.String getFileAs()
                           throws java.lang.Exception
Gets the name under which this contact group is filed as.

Returns:
the file as
Throws:
java.lang.Exception - the exception

getDisplayName

public java.lang.String getDisplayName()
                                throws java.lang.Exception
Gets the display name of the contact group.

Returns:
the display name
Throws:
java.lang.Exception - the exception

setDisplayName

public void setDisplayName(java.lang.String value)
                    throws java.lang.Exception
Sets the display name.

Parameters:
value - the new display name
Throws:
java.lang.Exception - the exception

getMembers

public GroupMemberCollection getMembers()
                                 throws java.lang.Exception
Gets the members of the contact group.

Returns:
the members
Throws:
java.lang.Exception - the exception

bind

public static ContactGroup bind(ExchangeService service,
                                ItemId id,
                                PropertySet propertySet)
                         throws java.lang.Exception
Binds to an existing contact group and loads the specified set of properties.Calling this method results in a call to EWS.

Parameters:
service - the service
id - the id
propertySet - the property set
Returns:
A ContactGroup instance representing the contact group corresponding to the specified Id
Throws:
java.lang.Exception - the exception

bind

public static ContactGroup bind(ExchangeService service,
                                ItemId id)
                         throws java.lang.Exception
Binds to an existing contact group and loads the specified set of properties.Calling this method results in a call to EWS.

Parameters:
service - the service
id - the id
Returns:
A ContactGroup instance representing the contact group corresponding to the specified Id.
Throws:
java.lang.Exception - the exception

getSchema

protected ServiceObjectSchema getSchema()
Internal method to return the schema associated with this type of object.

Overrides:
getSchema in class Item
Returns:
The schema associated with this type of object.

getMinimumRequiredServerVersion

protected ExchangeVersion getMinimumRequiredServerVersion()
Gets the minimum required server version.

Overrides:
getMinimumRequiredServerVersion in class Item
Returns:
Earliest Exchange version in which this service object type is supported.

setSubject

protected void setSubject(java.lang.String subject)
                   throws ServiceObjectPropertyException
Sets the subject.

Overrides:
setSubject in class Item
Parameters:
subject - the new subject
Throws:
ServiceObjectPropertyException - the service object property exception