de.jakop.lotus.domingo.groupware

Interface CalendarInterface

All Known Implementing Classes:

MailDatabase

public interface CalendarInterface

Interface to the calendar functionality of a Notes mail database.

Author:

Kurt Riede

Method Summary

Modifier and Type	Method and Description
Iterator	getCalendar() Returns an iterator over all entries in the Calendar.
Iterator	getCalendar(boolean reverseOrder) Returns an iterator over all entries in the Calendar.
Object	getCalendarEntry(CalendarEntryDigest ced) Given a CalendarEntryDigest, retrieve the corresponding CalendarEntry.
Object	getCalendarEntry(String unid) Returns a calendar entry for a given unid.
List	getObjects(Calendar from, Calendar to) Returns calendar objects within the specified time frame.
void	remove(CalendarEntry entry) Deletes an existing calendar entry.
void	remove(CalendarEntryDigest digest) Deletes an existing calendar entry.
void	save(CalendarEntry entry) Saves a new calendar entry.

Method Detail

save

void save(CalendarEntry entry)

Saves a new calendar entry.

Parameters:

entry - the calendar entry to save

getObjects

List getObjects(Calendar from,
                Calendar to)

Returns calendar objects within the specified time frame.

Parameters:

from - start date

to - end date

Returns:

list of calendar entries

getCalendar

Iterator getCalendar()

Returns an iterator over all entries in the Calendar.

Returns:

iterator over all entries in the Calendar.

getCalendar

Iterator getCalendar(boolean reverseOrder)

Returns an iterator over all entries in the Calendar.

Depending on how the Calendar is sorted (ascending or descending by date), choose where to start reading entries.

Parameters:

reverseOrder - true if iterator should iterate in reverse order

Returns:

iterator over all entries in the Calendar.

getCalendarEntry

Object getCalendarEntry(CalendarEntryDigest ced)

Given a CalendarEntryDigest, retrieve the corresponding CalendarEntry.

Parameters:

ced - the calendar entry digest

Returns:

CalendarEntry

getCalendarEntry

Object getCalendarEntry(String unid)
                 throws GroupwareException

Returns a calendar entry for a given unid.

Parameters:

unid - the Notes document unid

Returns:

the calendar entry

Throws:

GroupwareException - if the calendar entry cannot be found or mapped.

See Also:

CalendarEntry.getAppointmentUnid()

remove

void remove(CalendarEntry entry)

Deletes an existing calendar entry.

Parameters:

entry - an entry to delete

remove

void remove(CalendarEntryDigest digest)

Deletes an existing calendar entry.

Parameters:

digest - a calendar entry digest to delete