com.hcl.domino.freebusy

Interface Schedule

All Superinterfaces:

IAdaptable

public interface Schedule
extends IAdaptable

Schedule object to read busy and free time info for a single Domino user

Method Summary

Modifier and Type	Method and Description
List<DominoDateRange>	extractBusyTimeRange(String unidIgnore, TemporalAccessor from, TemporalAccessor until) Retrieves a user's busy times stored in this schedule
List<DominoDateRange>	extractFreeTimeRange(String unidIgnore, boolean findFirstFit, TemporalAccessor from, TemporalAccessor until, int duration) This routine retrieves one or more free time ranges from a schedule. It will only return 64k of free time ranges. Note: submitting a range or time that is in the past is not supported.
List<ScheduleEntry>	extractScheduleList(TemporalAccessor from, TemporalAccessor until) This retrieves the schedule list from a schedule.
String	getDbReplicaId() Returns the owner's mail file replica ID
Optional<DominoException>	getError() Returns an exception if loading the schedule failed
Optional<DominoDateTime>	getFrom() Lower bound of the interval
String	getOwner() Returns the owner of this schedule in canonical format
Optional<DominoDateTime>	getUntil() Upper bound of the interval

Methods inherited from interface com.hcl.domino.data.IAdaptable

getAdapter

Method Detail

getOwner

String getOwner()

Returns the owner of this schedule in canonical format

Returns:

owner

getDbReplicaId

String getDbReplicaId()

Returns the owner's mail file replica ID

Returns:

replica id

getFrom

Optional<DominoDateTime> getFrom()

Lower bound of the interval

Returns:

an Optional describing the lower bound, or an empty one if this is not available

getUntil

Optional<DominoDateTime> getUntil()

Upper bound of the interval

Returns:

an Optional describing the upper bound, or an empty one if this is not available

getError

Optional<DominoException> getError()

Returns an exception if loading the schedule failed

Returns:

an Optional describing the loading exception, or an empty one if there was no error

extractBusyTimeRange

List<DominoDateRange> extractBusyTimeRange(String unidIgnore,
                                           TemporalAccessor from,
                                           TemporalAccessor until)

Retrieves a user's busy times stored in this schedule

Parameters:

unidIgnore - UNID to ignore in busy time calculations or null

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

Returns:

busy times

extractFreeTimeRange

List<DominoDateRange> extractFreeTimeRange(String unidIgnore,
                                           boolean findFirstFit,
                                           TemporalAccessor from,
                                           TemporalAccessor until,
                                           int duration)

This routine retrieves one or more free time ranges from a schedule.
It will only return 64k of free time ranges.
Note: submitting a range or time that is in the past is not supported.

Parameters:

unidIgnore - UNID to ignore in busy time calculation or null

findFirstFit - If true then only the first fit is used

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).

Returns:

timedate pairs indicating runs of free time

extractScheduleList

List<ScheduleEntry> extractScheduleList(TemporalAccessor from,
                                        TemporalAccessor until)

This retrieves the schedule list from a schedule. A schedule list contains more appointment details than just from/until times that can be read via extractBusyTimeRange(String, TemporalAccessor, TemporalAccessor), e.g. the UNID/ApptUNID of the appointments.

Parameters:

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

Returns:

schedule list