com.hcl.domino.freebusy

Interface FreeBusy

public interface FreeBusy

Includes O.o.o info

Author:

t.b.d

Method Summary

Modifier and Type	Method and Description
List<DominoDateRange>	freeTimeSearch(String apptUnid, TemporalAccessor apptOrigDate, boolean findFirstFit, TemporalAccessor from, TemporalAccessor until, int duration, Collection<String> names) This routine searches the schedule database (locally or on a specified server) for free time periods common to a specified list of people.
Schedules	retrieveSchedules(String apptUnid, Collection<ScheduleOptions> options, TemporalAccessor from, TemporalAccessor until, Collection<String> names) Synchronously retrieves a local or remote schedule by asking the caller's home server for the schedule. The ONLY time that local busy time is used is when the client is in the Disconnected mode which is specified through the location document. Otherwise, the API will route ALL lookup requests to the users home server for processing.

Method Detail

freeTimeSearch

List<DominoDateRange> freeTimeSearch(String apptUnid,
                                     TemporalAccessor apptOrigDate,
                                     boolean findFirstFit,
                                     TemporalAccessor from,
                                     TemporalAccessor until,
                                     int duration,
                                     Collection<String> names)

This routine searches the schedule database (locally or on a specified server) for free time periods common to a specified list of people.

Parameters:

apptUnid - This is the UNID of an appointment to ignore for the purposes of calculating free time. This is useful when you need to move an appointment to a time which overlaps it. Can be null

apptOrigDate - This is the date of the original date of the appointment to ignore for free time calculations. Note that the only reason that this is here is for compatibility with Organizer 2.x gateway.

findFirstFit - If this value is equal to TRUE then this routine will return just the first free time interval that fits the duration. The size of this interval will equal to duration.

from - specifies the start of the range over which the free time search should be performed. In typical scheduling applications, this might be a range of 1 day or 5 days

until - specifies the end of the range over which the free time search should be performed. In typical scheduling applications, this might be a range of 1 day or 5 days

duration - How much free time you are looking for, in minutes (max 65535).

names - list of distinguished names whose schedule should be searched, either in abbreviated or canonical format

Returns:

timedate pairs indicating runs of free time

retrieveSchedules

Schedules retrieveSchedules(String apptUnid,
                            Collection<ScheduleOptions> options,
                            TemporalAccessor from,
                            TemporalAccessor until,
                            Collection<String> names)

Synchronously retrieves a local or remote schedule by asking the caller's home server for the schedule.

The ONLY time that local busy time is used is when the client is in the Disconnected mode which is specified through the location document.

Otherwise, the API will route ALL lookup requests to the users home server for processing.

Parameters:

apptUnid - Ignore this UNID in computations

options - option flags

from - specifies the start of the range over which the schedule lookup should be performed. In typical scheduling applications, this might be a range of 1 day or 5 days

until - specifies the end of the range over which the schedule lookup should be performed. In typical scheduling applications, this might be a range of 1 day or 5 days

names - list of distinguished names whose schedule should be searched, either in abbreviated or canonical format

Returns:

schedules list