Overview  Package   Class  Tree  Deprecated  Index  Help 
Compoze Software, Inc.
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

com.compoze.exchange.webdav
Class CalendarFolder


java.lang.Object

  |

  +--com.compoze.exchange.webdav.AbstractItem

        |

        +--com.compoze.exchange.webdav.Folder

              |

              +--com.compoze.exchange.webdav.CalendarFolder
All Implemented Interfaces:
java.lang.Cloneable, IItem, java.io.Serializable
public class CalendarFolder
extends Folder
implements java.io.Serializable

This class extends Folder to represent a folder that primarily contains appointment items. This class provides methods to retrieve collections of appointments.

The following example gets those appointments with the subject "Test appointment subject". The appointments returned are sorted by the start and end dates: 

  //  Prepare a filter to find appointments with subject of "Test appointment subject"
  AppointmentFilter filter = new AppointmentFilter();
  filter.setSubject("Test appointment subject", true);

  //  Sort Messages by start and end date
  SortOrder sortOrder = SortOrder.create(CalendarProperty.DATE_START, SortOrder.ASCENDING);
  sortOrder.add(CalendarProperty.DATE_END, SortOrder.ASCENDING);   	

  Appointments appointments = calendarFolder.getAppointments(Appointment.getDefaultProperties(), 
     filter, sortOrder);

The following example gets those appointments found between specified dates and are either a non-recurring appointment, a single instance of a recurring appointment, or an exception to a recurring appointment. The appointments returned are sorted by the start and end dates: 

  //  Prepare a filter to find appointments
  AppointmentFilter filter = new AppointmentFilter();
  filter.setContentClass(ContentClass.APPOINTMENT.getValue(), false);

  //  Build date conditions
  AppointmentFilter datesFilter = new AppointmentFilter();
  datesFilter.setByDates(startDate, endDate);

  //  Add to base filter
  filter.setCondition(datesFilter, false);

  // Build instance conditions
  AppointmentFilter instanceFilter = new AppointmentFilter();
  instanceFilter.setInstanceType(InstanceType.EXCEPTION);
  instanceFilter.setInstanceType(InstanceType.INSTANCE);
  instanceFilter.setInstanceType(InstanceType.SINGLE);
  
  //  Add to base filter
  filter.setCondition(instanceFilter, false);

  //  Sort appointments by start and end date
  SortOrder sortOrder = SortOrder.create(CalendarProperty.DATE_START, SortOrder.ASCENDING);
  sortOrder.add(CalendarProperty.DATE_END, SortOrder.ASCENDING);   	

  Appointments appointments = calendarFolder.getAppointments(Appointment.getDefaultProperties(), 
     filter, sortOrder);

See Also:
Serialized Form

Fields inherited from class com.compoze.exchange.webdav.Folder
m_folders, m_iRelDepth, m_messages
 
Constructor Summary
CalendarFolder(java.lang.String sName)
          Constructor.
 
Method Summary
 Appointments getAppointments()
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)
 Appointments getAppointments(AppointmentFilter filter)
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)
 Appointments getAppointments(AppointmentFilter filter, SortOrder sortOrder)
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)
 Appointments getAppointments(boolean bExcludeMasterAppointments)
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)
 Appointments getAppointments(java.util.Calendar calendar, java.util.Date startDate, java.util.Date endDate)
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, Date, Date, SortOrder, RowRange)
 Appointments getAppointments(java.util.Calendar calendar, java.util.Date startDate, java.util.Date endDate, boolean bExcludeMasterAppointments)
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, Date, Date, boolean, SortOrder, RowRange)
 Appointments getAppointments(java.util.Date startDate, java.util.Date endDate)
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, Date, Date, SortOrder, RowRange)
 Appointments getAppointments(java.util.Date startDate, java.util.Date endDate, boolean bExcludeMasterAppointments)
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, int, AppointmentFilter, SortOrder, RowRange)
 Appointments getAppointments(java.util.Date startDate, java.util.Date endDate, boolean bExcludeMasterAppointments, java.util.List props)
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, Date, Date, boolean, SortOrder, RowRange)
 Appointments getAppointments(java.util.Date startDate, java.util.Date endDate, boolean bExcludeMasterAppointments, java.util.List props, SortOrder sortOrder, RowRange range)
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, Date, Date, boolean, SortOrder, RowRange)
 Appointments getAppointments(java.util.Date startDate, java.util.Date endDate, boolean bExcludeMasterAppointments, RowRange range)
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, Date, Date, boolean, SortOrder, RowRange)
 Appointments getAppointments(java.util.Date startDate, java.util.Date endDate, boolean bExcludeMasterAppointments, SortOrder sortOrder)
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, Date, Date, boolean, SortOrder, RowRange)
 Appointments getAppointments(java.util.List props)
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)
 Appointments getAppointments(java.util.List props, AppointmentFilter filter)
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)
 Appointments getAppointments(java.util.List props, AppointmentFilter filter, SortOrder sortOrder)
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)
 Appointments getAppointments(java.util.List properties, AppointmentFilter filter, SortOrder order, RowRange range)
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)
 Appointments getAppointments(java.util.List props, boolean bExcludeMasterAppointments)
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)
 Appointments getAppointments(java.util.List properties, java.util.Date startDate, java.util.Date endDate, boolean bExcludeMasterInstance, SortOrder order, RowRange range)
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, Date, Date, boolean, SortOrder, RowRange)
 Appointments getAppointments(java.util.List properties, java.util.Date startDate, java.util.Date endDate, SortOrder order, RowRange range)
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, Date, Date, SortOrder, RowRange)
 Appointments getAppointments(java.util.List properties, int iScope, AppointmentFilter filter, SortOrder order, RowRange range)
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, int, AppointmentFilter, SortOrder, RowRange)
 Appointments getAppointments(java.util.List props, SortOrder sortOrder)
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)
 Appointments getAppointments(java.util.List props, SortOrder sortOrder, boolean bExcludeMasterAppointments)
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)
 Appointments getAppointments(java.util.List properties, SortOrder order, RowRange range)
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, SortOrder, RowRange)
 Appointments getAppointments(SortOrder sortOrder)
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)
 Appointments getAppointments(SortOrder sortOrder, boolean bExcludeMasterAppointments)
          Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)
 Appointments serverGetAppointments(java.util.List properties, AppointmentFilter filter, SortOrder order, RowRange range)
          Queries the server for a list of appointments.
 Appointments serverGetAppointments(java.util.List properties, java.util.Date startDate, java.util.Date endDate, boolean bExcludeMasterInstance, SortOrder order, RowRange range)
          Queries the server for a list of appointments.
 Appointments serverGetAppointments(java.util.List properties, java.util.Date startDate, java.util.Date endDate, SortOrder order, RowRange range)
          Queries the server for a list of appointments.
 Appointments serverGetAppointments(java.util.List properties, int iScope, AppointmentFilter filter, SortOrder order, RowRange range)
          Queries the server for a list of appointments.
 Appointments serverGetAppointments(java.util.List properties, SortOrder order, RowRange range)
          Queries the server for a list of appointments.
 
Methods inherited from class com.compoze.exchange.webdav.Folder
addItem, addItem, clone, createFilename, deleteItem, deleteItem, equals, getDefaultProperties, getFolder, getFolder, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getFolders, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getItems, getLocalFolders, getLocalItems, getLocalMessages, getMessageCount, getProperties, getRelativeDepth, getSize, getType, getUnreadCount, getUnreadCount, getUnreadMessageCount, getVisibleCount, getVisibleCount, getVisibleCount, getVisibleCount, hasSubFolders, isDeletedItemsFolder, isDraftsFolder, isInboxFolder, isOutboxFolder, isSentItemsFolder, rename, serverAddItem, serverAddItem, serverDelete, serverDeleteItem, serverDeleteItem, serverGetFolders, serverGetFolders, serverGetFolders, serverGetFolders, serverGetMessageCount, serverGetMessageCount, serverGetMessages, serverGetMessages, serverGetMessages, serverGetUnreadMessageCount, serverRename, serverUpdate, setRelativeDepth, setType, toString
 
Methods inherited from class com.compoze.exchange.webdav.AbstractItem
copy, copy, copy, createFilename, delete, equals, getComment, getContentClass, getCreationDate, getDateLastModified, getDisplayName, getFile, getHRef, getID, getParentFolder, getPermanentURL, getUID, isFolder, isHidden, isReadOnly, isRoot, move, move, move, serverCopyTo, serverCopyTo, serverCopyTo, serverCopyTo, serverGetParentFolder, serverMoveTo, serverMoveTo, serverMoveTo, serverMoveTo, serverUpdate, setComment, setContentClass, setContentClass, setHidden, setReadOnly, setReleased, setType, setUID, update, update, validate
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CalendarFolder


public CalendarFolder(java.lang.String sName)
Constructor.
Parameters:
sName - name of the folder
Method Detail

serverGetAppointments


public Appointments serverGetAppointments(java.util.List properties,
                                          java.util.Date startDate,
                                          java.util.Date endDate,
                                          SortOrder order,
                                          RowRange range)
                                   throws ExchangeException
Queries the server for a list of appointments.
Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
startDate - the start date (inclusive)
endDate - the end date (exclusive)
order - the order to sort by
range - the range of rows to return
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used
java.lang.IllegalArgumentException - if properties are not specified

serverGetAppointments


public Appointments serverGetAppointments(java.util.List properties,
                                          java.util.Date startDate,
                                          java.util.Date endDate,
                                          boolean bExcludeMasterInstance,
                                          SortOrder order,
                                          RowRange range)
                                   throws ExchangeException
Queries the server for a list of appointments.
Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
startDate - the start date (inclusive)
endDate - the end date (exclusive)
bExcludeMasterInstance - true to exclude all master instances of recurring appointments
order - the order to sort by
range - the range of rows to return
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used
java.lang.IllegalArgumentException - if properties are not specified

serverGetAppointments


public Appointments serverGetAppointments(java.util.List properties,
                                          SortOrder order,
                                          RowRange range)
                                   throws ExchangeException
Queries the server for a list of appointments.
Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
order - the order to sort by
range - the range of rows to return
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used
java.lang.IllegalArgumentException - if properties are not specified

serverGetAppointments


public Appointments serverGetAppointments(java.util.List properties,
                                          AppointmentFilter filter,
                                          SortOrder order,
                                          RowRange range)
                                   throws ExchangeException
Queries the server for a list of appointments.
Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
filter - the conditions to search by
order - the order to sort by
range - the range of rows to return
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used
java.lang.IllegalArgumentException - if properties are not specified

serverGetAppointments


public Appointments serverGetAppointments(java.util.List properties,
                                          int iScope,
                                          AppointmentFilter filter,
                                          SortOrder order,
                                          RowRange range)
                                   throws ExchangeException
Queries the server for a list of appointments.

If no sort order is provided (sortOrder == null), the following sort order is used:

DO NOT SORT BY HttpMailProperty.SUBJECT. This property is not searchable because its value is only calculated when used and not stored in the Exchange store. Use HttpMailProperty.NORMALIZED_SUBJECT or MailHeaderProperty.SUBJECT.

Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
iScope - the scope of the search
filter - the conditions to search by
order - the order to sort by
range - the range of rows to return
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used
java.lang.IllegalArgumentException - if properties are not specified

getAppointments


public Appointments getAppointments(java.util.List properties,
                                    java.util.Date startDate,
                                    java.util.Date endDate,
                                    SortOrder order,
                                    RowRange range)
                             throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, Date, Date, SortOrder, RowRange)

Queries the server for a list of appointments.
Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
startDate - the start date (inclusive)
endDate - the end date (exclusive)
order - the order to sort by
range - the range of rows to return
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used
java.lang.IllegalArgumentException - if properties are not specified

getAppointments


public Appointments getAppointments(java.util.List properties,
                                    java.util.Date startDate,
                                    java.util.Date endDate,
                                    boolean bExcludeMasterInstance,
                                    SortOrder order,
                                    RowRange range)
                             throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, Date, Date, boolean, SortOrder, RowRange)

Queries the server for a list of appointments.
Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
startDate - the start date (inclusive)
endDate - the end date (exclusive)
bExcludeMasterInstance - true to exclude all master instances of recurring appointments
order - the order to sort by
range - the range of rows to return
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used
java.lang.IllegalArgumentException - if properties are not specified

getAppointments


public Appointments getAppointments(java.util.List properties,
                                    SortOrder order,
                                    RowRange range)
                             throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, SortOrder, RowRange)

Queries the server for a list of appointments.
Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
order - the order to sort by
range - the range of rows to return
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used
java.lang.IllegalArgumentException - if properties are not specified

getAppointments


public Appointments getAppointments(java.util.List properties,
                                    AppointmentFilter filter,
                                    SortOrder order,
                                    RowRange range)
                             throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)

Queries the server for a list of appointments.
Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
filter - the conditions to search by
order - the order to sort by
range - the range of rows to return
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used
java.lang.IllegalArgumentException - if properties are not specified

getAppointments


public Appointments getAppointments(java.util.List properties,
                                    int iScope,
                                    AppointmentFilter filter,
                                    SortOrder order,
                                    RowRange range)
                             throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, int, AppointmentFilter, SortOrder, RowRange)

Queries the server for a list of appointments.

If no sort order is provided (sortOrder == null), the following sort order is used:

DO NOT SORT BY HttpMailProperty.SUBJECT. This property is not searchable because its value is only calculated when used and not stored in the Exchange store. Use HttpMailProperty.NORMALIZED_SUBJECT or MailHeaderProperty.SUBJECT.

Parameters:
properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)
iScope - the scope of the search
filter - the conditions to search by
order - the order to sort by
range - the range of rows to return
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used
java.lang.IllegalArgumentException - if properties are not specified

getAppointments


public Appointments getAppointments(java.util.Date startDate,
                                    java.util.Date endDate)
                             throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, Date, Date, SortOrder, RowRange)

Queries the server for a list of appointments.

Gets a list of appointments whose start and/or end times fall between the specified dates, excluding those appointments that fall on the end date, with the default properties returned and by default sorted by start date and end date fields.
For example, if the the specified start date is May 1, 2002 and the specified end date is June 1, 2002, all appointments will be returned from the May 1, 2002 up to (not including) the June 1, 2002.

A call to this method will not return recurring appointments that are master instances. Appointments that are returned include single appointment instances, and exceptions and instances of the master appontment instance.

Parameters:
startDate - the start date (inclusive)
endDate - the end date (exclusive)
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getAppointments


public Appointments getAppointments(java.util.Calendar calendar,
                                    java.util.Date startDate,
                                    java.util.Date endDate)
                             throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, Date, Date, SortOrder, RowRange)

Queries the server for a list of appointments.

Gets a list of appointments whose start and/or end times fall between the specified dates, excluding those appointments that fall on the end date, with the default properties returned and by default sorted by start date and end date fields.
For example, if the the specified start date is May 1, 2002 and the specified end date is June 1, 2002, all appointments will be returned from the May 1, 2002 up to (not including) the June 1, 2002.

A call to this method will not return recurring appointments that are master instances. Appointments that are returned include single appointment instances, and exceptions and instances of the master appontment instance.

Parameters:
calendar - the calendar to use
startDate - the start date
endDate - the end date
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getAppointments


public Appointments getAppointments()
                             throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)

Queries the server for a list of appointments.
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getAppointments


public Appointments getAppointments(java.util.List props)
                             throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)

Queries the server for a list of appointments.

See getAppointments(List, com.compoze.exchange.webdav.filter.AppointmentFilter, SortOrder, RowRange) for futher details.

Parameters:
props - list of properties (see Appointment) to have returned from the query
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used
java.lang.IllegalArgumentException - if properties are not specified
See Also:
Appointment.getDefaultProperties(), Appointment.getProperties()

getAppointments


public Appointments getAppointments(java.util.List props,
                                    SortOrder sortOrder)
                             throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)

Queries the server for a list of appointments.

See getAppointments(List, com.compoze.exchange.webdav.filter.AppointmentFilter, SortOrder, RowRange) for futher details.

Parameters:
props - list of properties (see Appointment) to have returned from the query
sortOrder - the order to sort by
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used
java.lang.IllegalArgumentException - if properties are not specified
See Also:
Appointment.getDefaultProperties(), Appointment.getProperties()

getAppointments


public Appointments getAppointments(java.util.List props,
                                    AppointmentFilter filter)
                             throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)

Queries the server for a list of appointments.

See getAppointments(List, com.compoze.exchange.webdav.filter.AppointmentFilter, SortOrder, RowRange) for futher details.

Parameters:
props - list of properties (see Appointment) to have returned from the query
filter - the filter to search by
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used
java.lang.IllegalArgumentException - if properties are not specified
See Also:
Appointment.getDefaultProperties(), Appointment.getProperties()

getAppointments


public Appointments getAppointments(SortOrder sortOrder)
                             throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)

Queries the server for a list of appointments.

See getAppointments(List, com.compoze.exchange.webdav.filter.AppointmentFilter, SortOrder, RowRange) for futher details.

Parameters:
sortOrder - the order to sort by
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getAppointments


public Appointments getAppointments(AppointmentFilter filter)
                             throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)

Queries the server for a list of appointments.

See getAppointments(List, com.compoze.exchange.webdav.filter.AppointmentFilter, SortOrder, RowRange) for futher details.

Parameters:
filter - the filter to search by
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getAppointments


public Appointments getAppointments(AppointmentFilter filter,
                                    SortOrder sortOrder)
                             throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)

Queries the server for a list of appointments.

See getAppointments(List, com.compoze.exchange.webdav.filter.AppointmentFilter, SortOrder, RowRange) for futher details.

Parameters:
filter - the filter to search by
sortOrder - the order to sort by
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getAppointments


public Appointments getAppointments(java.util.List props,
                                    AppointmentFilter filter,
                                    SortOrder sortOrder)
                             throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)

Queries the server for a list of appointments.

See getAppointments(List, com.compoze.exchange.webdav.filter.AppointmentFilter, SortOrder, RowRange) for futher details.

Parameters:
props - list of properties (see Appointment) to have returned from the query
filter - the filter to search by
sortOrder - the order to sort by
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used
java.lang.IllegalArgumentException - if properties are not specified
See Also:
Appointment.getDefaultProperties(), Appointment.getProperties()

getAppointments


public Appointments getAppointments(java.util.Date startDate,
                                    java.util.Date endDate,
                                    boolean bExcludeMasterAppointments)
                             throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, int, AppointmentFilter, SortOrder, RowRange)

Queries the server for a list of appointments.

Gets a list of appointments that start or end between the specified dates. To exclude the master instance of a recurring appointment, set bExcludeMasterAppointments to true.

Parameters:
startDate - the start date (inclusive).
endDate - the end date (exclusive).
bExcludeMasterAppointments - true to exclude the master instance of recurring appointments.
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used
See Also:
Appointment.getDefaultProperties(), Appointment.getProperties()

getAppointments


public Appointments getAppointments(java.util.Date startDate,
                                    java.util.Date endDate,
                                    boolean bExcludeMasterAppointments,
                                    java.util.List props)
                             throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, Date, Date, boolean, SortOrder, RowRange)

Queries the server for a list of appointments.

Gets a list of appointments containing the specified properties that start or end between the specified dates. To exclude the master instance of a recurring appointment, set bExcludeMasterAppointments to true.

Parameters:
startDate - the start date (inclusive).
endDate - the end date (exclusive).
bExcludeMasterAppointments - true to exclude the master instance of recurring appointments.
props - list of properties (see Appointment) to have returned from the query.
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used
See Also:
Appointment.getDefaultProperties(), Appointment.getProperties()

getAppointments


public Appointments getAppointments(java.util.Date startDate,
                                    java.util.Date endDate,
                                    boolean bExcludeMasterAppointments,
                                    SortOrder sortOrder)
                             throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, Date, Date, boolean, SortOrder, RowRange)

Queries the server for a list of appointments.

Gets a list of appointments between the specified dates in the specified order. To exclude the master instance of a recurring appointment, set bExcludeMasterAppointments to true.

Parameters:
startDate - the start date (inclusive).
endDate - the end date (exclusive).
bExcludeMasterAppointments - true to exclude the master instance of recurring appointments.
sortOrder - the order to sort by.
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used
See Also:
Appointment.getDefaultProperties(), Appointment.getProperties()

getAppointments


public Appointments getAppointments(java.util.Date startDate,
                                    java.util.Date endDate,
                                    boolean bExcludeMasterAppointments,
                                    RowRange range)
                             throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, Date, Date, boolean, SortOrder, RowRange)

Queries the server for a list of appointments.

Gets a list of appointments that start or end between the specified dates. To exclude the master instance of a recurring appointment, set bExcludeMasterAppointments to true.

Parameters:
startDate - the start date (inclusive).
endDate - the end date (exclusive).
bExcludeMasterAppointments - true to exclude the master instance of recurring appointments.
range - the rows to return.
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used
See Also:
Appointment.getDefaultProperties(), Appointment.getProperties()

getAppointments


public Appointments getAppointments(java.util.Date startDate,
                                    java.util.Date endDate,
                                    boolean bExcludeMasterAppointments,
                                    java.util.List props,
                                    SortOrder sortOrder,
                                    RowRange range)
                             throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, Date, Date, boolean, SortOrder, RowRange)

Queries the server for a list of appointments.

Gets a list of appointments containing the specified properties that start or end between the specified dates in the specified order. To exclude the master instance of a recurring appointment, set bExcludeMasterAppointments to true.
See getAppointments(List, com.compoze.exchange.webdav.filter.AppointmentFilter, SortOrder, RowRange) for further details

Parameters:
startDate - the start date (inclusive).
endDate - the end date (exclusive).
bExcludeMasterAppointments - true to exclude the master instance of recurring appointments.
props - list of properties (see Appointment) to have returned from the query.
sortOrder - the order to sort by.
range - the rows to return.
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used
java.lang.IllegalArgumentException - if properties are not specified
See Also:
Appointment.getDefaultProperties(), Appointment.getProperties()

getAppointments


public Appointments getAppointments(java.util.Calendar calendar,
                                    java.util.Date startDate,
                                    java.util.Date endDate,
                                    boolean bExcludeMasterAppointments)
                             throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, Date, Date, boolean, SortOrder, RowRange)

Queries the server for a list of appointments.

Gets a list of appointments whose start and/or end times fall between the specified dates, excluding those appointments that fall on the end date, with the default properties returned and by default sorted by start date and end date fields.
For example, if the the specified start date is May 1, 2002 and the specified end date is June 1, 2002, all appointments will be returned from the May 1, 2002 up to (not including) the June 1, 2002.

Parameters:
calendar - the calendar to use
startDate - the start date
endDate - the end date
bExcludeMasterAppointments - true to exclude all master recurring appointments
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getAppointments


public Appointments getAppointments(boolean bExcludeMasterAppointments)
                             throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)

Queries the server for a list of appointments.
Parameters:
bExcludeMasterAppointments - true to exclude all master recurring appointments
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getAppointments


public Appointments getAppointments(java.util.List props,
                                    boolean bExcludeMasterAppointments)
                             throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)

Queries the server for a list of appointments.
Parameters:
props - list of properties (see Appointment) to have returned from the query
bExcludeMasterAppointments - true to exclude all master recurring appointments
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used
java.lang.IllegalArgumentException - if properties are not specified
See Also:
Appointment.getDefaultProperties(), Appointment.getProperties()

getAppointments


public Appointments getAppointments(SortOrder sortOrder,
                                    boolean bExcludeMasterAppointments)
                             throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)

Queries the server for a list of appointments.
Parameters:
sortOrder - the order to sort by
bExcludeMasterAppointments - true to exclude all master recurring appointments
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used

getAppointments


public Appointments getAppointments(java.util.List props,
                                    SortOrder sortOrder,
                                    boolean bExcludeMasterAppointments)
                             throws ExchangeException
Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverGetAppointments(List, AppointmentFilter, SortOrder, RowRange)

Queries the server for a list of appointments.
Parameters:
props - list of properties (see Appointment) to have returned from the query
sortOrder - the order to sort by
bExcludeMasterAppointments - true to exclude all master recurring appointments
Returns:
a list of Appointment objects
Throws:
ExchangeException - if a problem occurred while interacting with the Exchange store
ExchangeRuntimeException - if this object has been released and can no longer be used
java.lang.IllegalArgumentException - if properties are not specified
See Also:
Appointment.getDefaultProperties(), Appointment.getProperties()
Overview  Package   Class  Tree  Deprecated  Index  Help 
Compoze Software, Inc.
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright ©1999-2003 Compoze Software, Inc. All rights reserved.