microsoft.exchange.webservices.data.core.service.item.ContactGroup Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ews-java-api Show documentation
Show all versions of ews-java-api Show documentation
Exchange Web Services (EWS) Java API
/*
* The MIT License
* Copyright (c) 2012 Microsoft Corporation
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package microsoft.exchange.webservices.data.core.service.item;
import microsoft.exchange.webservices.data.attribute.RequiredServerVersion;
import microsoft.exchange.webservices.data.attribute.ServiceObjectDefinition;
import microsoft.exchange.webservices.data.core.ExchangeService;
import microsoft.exchange.webservices.data.core.PropertySet;
import microsoft.exchange.webservices.data.core.XmlElementNames;
import microsoft.exchange.webservices.data.core.service.schema.ContactGroupSchema;
import microsoft.exchange.webservices.data.core.service.schema.ContactSchema;
import microsoft.exchange.webservices.data.core.service.schema.ServiceObjectSchema;
import microsoft.exchange.webservices.data.core.enumeration.misc.ExchangeVersion;
import microsoft.exchange.webservices.data.core.exception.service.local.ServiceObjectPropertyException;
import microsoft.exchange.webservices.data.property.complex.GroupMemberCollection;
import microsoft.exchange.webservices.data.property.complex.ItemAttachment;
import microsoft.exchange.webservices.data.property.complex.ItemId;
/**
* Represents a Contact Group. Properties available on contact groups are
* defined in the ContactGroupSchema class.
*/
@ServiceObjectDefinition(xmlElementName = XmlElementNames.DistributionList, returnedByServer = true)
public class ContactGroup extends Item {
/**
* Initializes an unsaved local instance of the class.
*
* @param service the service
* @throws Exception the exception
*/
public ContactGroup(ExchangeService service) throws Exception {
super(service);
}
/**
* Initializes an new instance of the class.
*
* @param parentAttachment the parent attachment
* @throws Exception the exception
*/
public ContactGroup(ItemAttachment parentAttachment) throws Exception {
super(parentAttachment);
}
/**
* Gets the name under which this contact group is filed as.
*
* @return the file as
* @throws Exception the exception
*/
@RequiredServerVersion(version = ExchangeVersion.Exchange2010)
public String getFileAs() throws Exception {
return (String) this
.getObjectFromPropertyDefinition(ContactSchema.FileAs);
}
/**
* Gets the display name of the contact group.
*
* @return the display name
* @throws Exception the exception
*/
public String getDisplayName() throws Exception {
return (String) this
.getObjectFromPropertyDefinition(ContactSchema.DisplayName);
}
/**
* Sets the display name.
*
* @param value the new display name
* @throws Exception the exception
*/
public void setDisplayName(String value) throws Exception {
this.getPropertyBag().setObjectFromPropertyDefinition(
ContactSchema.DisplayName, value);
}
/**
* Gets the members of the contact group.
*
* @return the members
* @throws Exception the exception
*/
@RequiredServerVersion(version = ExchangeVersion.Exchange2010)
public GroupMemberCollection getMembers() throws Exception {
return (GroupMemberCollection) this
.getObjectFromPropertyDefinition(ContactGroupSchema.Members);
}
/**
* Binds to an existing contact group and loads the specified set of
* property.Calling this method results in a call to EWS.
*
* @param service the service
* @param id the id
* @param propertySet the property set
* @return A ContactGroup instance representing the contact group
* corresponding to the specified Id
* @throws Exception the exception
*/
public static ContactGroup bind(ExchangeService service, ItemId id,
PropertySet propertySet) throws Exception {
return service.bindToItem(ContactGroup.class, id, propertySet);
}
/**
* Binds to an existing contact group and loads the specified set of
* property.Calling this method results in a call to EWS.
*
* @param service the service
* @param id the id
* @return A ContactGroup instance representing the contact group
* corresponding to the specified Id.
* @throws Exception the exception
*/
public static ContactGroup bind(ExchangeService service, ItemId id)
throws Exception {
return ContactGroup.bind(service, id, PropertySet
.getFirstClassProperties());
}
/**
* Internal method to return the schema associated with this type of object.
*
* @return The schema associated with this type of object.
*/
@Override public ServiceObjectSchema getSchema() {
return ContactGroupSchema.Instance;
}
/**
* Gets the minimum required server version.
*
* @return Earliest Exchange version in which this service object type is
* supported.
*/
@Override public ExchangeVersion getMinimumRequiredServerVersion() {
return ExchangeVersion.Exchange2007_SP1;
}
/**
* Sets the subject.
*
* @param subject the new subject
* @throws ServiceObjectPropertyException the service object property exception
*/
@Override
public void setSubject(String subject)
throws ServiceObjectPropertyException {
// Set is disabled in client API even though it is implemented in
// protocol for Item.Subject.
// Setting Subject out of sync with DisplayName breaks interop with OLK.
// See E14:70417, 65663, 6529.
throw new ServiceObjectPropertyException("This property is read-only and can't be set.",
ContactGroupSchema.Subject);
}
}