com.hcl.domino.calendar

Interface Calendaring

public interface Calendaring

Interface to access the Calendaring and Scheduling APIs of Domino.

Please note that this interface is not feature complete. We currently support creating, updating and reading appointments, but we do not yet support Domino's meeting workflow (accept/decline etc.)

Author:

Tammo Riedinger

Method Summary

Modifier and Type	Method and Description
CalendarActionData	buildActionData() Use this method to start building the data object to be passed along calendar actions;
String	createCalendarEntry(Database dbMail, String iCal, Collection<CalendarWrite> flags) Creates a calendar entry. This supports either a single entry, or a recurring entry which may contain multiple VEVENTS represenging both the series and exception data.
void	entryAction(Database dbMail, String uid, String recurId, Collection<CalendarProcess> action, CalendarRangeRepeat scope, String comment, CalendarActionData data, Collection<CalendarActionOptions> flags) Perform an action on a calendar entry. For instance, change the response of an accepted meeting to counter or delegate. This must be applied to meetings (with the exception of CalendarProcess.DELETE, which can be applied to any calendar entry). This makes the appropriate modifications to the invitee calendar and also sends appropriate notices out.
String	getApptUnidFromUID(String uid) This is a convenience method that returns an Apptunid value that corresponds to a UID.
int	getNewInvitations(Database dbMail, TemporalAccessor start, String uid, TemporalAccessor since, AtomicReference<DominoDateTime> retUntil, List<Integer> retNoteIds, List<String> retUNIDs) Retrieve invitations in a mailfile that have not yet been responded to. This returns the number of new invitations as well as optional NOTEID and/or UNID lists. This returns only invitations (and delegated invitations), and not reschedules, information updates, cancels, etc. This method does not filter out any invitations that have since been canceled/rescheduled, or are otherwise out of date. Once the invitation is accepted, other notices that apply to that meeting can be discovered with a call to getUnappliedNotices(Database, String, List, List) must be used (on a per-UID level). Only invitations for meetings that are current (at least one instance starts within the last day or in the future) are returned, although the starting time can be specified by the caller to override the default.A caller can retrieve only invitations that have arrived since a prior call to getNewInvitations(com.hcl.domino.data.Database, java.time.temporal.TemporalAccessor, java.lang.String, java.time.temporal.TemporalAccessor, java.util.concurrent.atomic.AtomicReference<com.hcl.domino.data.DominoDateTime>, java.util.List<java.lang.Integer>, java.util.List<java.lang.String>) by using tdSince and ptdretUntil.If uid is provided, invitations only for a particular meeting will be returned. This is useful if you are looking for an invitation or invitations that correspond to an updated notice that has arrived. Note: Multiple invitations might exist for a particular UID if that meeting is recurring and you were added to an instance or instances after the initial creation. The returned notices are not guaranteed to be in any particular order.
String	getRecurrenceID(TemporalAccessor td) This is a convenience method that returns a RECURRENCE-ID (in UTC time) from a TemporalAccessor object.
String	getUIDfromDocument(Document document) This is a convinience method that returns a UID for a calendar entry document. NOTEID->UID is a many to one mapping since one or several documents may represent a calendar entry (especially if it repeats) and its related notices.
String	getUIDfromNoteID(Database dbMail, int noteId) This is a convinience method that returns a UID from a NOTEID. NOTEID->UID is a many to one mapping since one or several notes may represent a calendar entry (especially if it repeats) and its related notices.
String	getUIDFromUNID(Database dbMail, String unid) This is a convinience method that returns a UID from a UNID. UNID->UID is a many to one mapping since one or several notes may represent a calendar entry (especially if it repeats) and its related notices. As such, the UID output will be the same for all notes that refer to the same calendar entry. This method may incur a note open, so there could be performance impact.
int	getUnappliedNotices(Database dbMail, String uid, List<Integer> retNoteIds, List<String> retUNIDs) Retrieve the unapplied notices that exist for a participant of calendar entry representing a meeting. This will return things like: Reschedules, informational updates, cancelations, confirmations, etc. Notices will only be returned if the initial invitation has already been responded to, otherwise this method will return ERR_INVITE_NOT_ACCEPTED. For recurring meetings, notices that apply to any instances in the series will be returned, with the exception of instances where the initial invitation has not yet been responded to. Calendar entries that are not meetings will return ERR_INVALID_NOTE. We do not currently support getting unprocessed calendar entries if you are the owner (such as a counter proposal request or a request for updated information), so this will return ERR_NOT_YET_IMPLEMENTED. Note: For recurring meetings, it is possible that multiple notices will contain current information for a particular occurence, so it is not possible to guarantee that there is a single "most current" notice. For example, the subject might be changed for a single instance, and then the time may be changed across instances. Because only one notice will have the current subject and another notice will have the current time but NOT the current subject, both notices will be returned and both must be processed to guarantee accuracy. Process returned notices via the CalNoticeAction method.
void	noticeAction(Database dbMail, int noteId, Collection<CalendarProcess> action, String comment, CalendarActionData data, Collection<CalendarActionOptions> flags) Process a calendar notice. This makes the appropriate modifications to the calendar entry and also sends appropriate notices out.
void	noticeAction(Database dbMail, String unid, Collection<CalendarProcess> action, String comment, CalendarActionData data, Collection<CalendarActionOptions> flags) Process a calendar notice. This makes the appropriate modifications to the calendar entry and also sends appropriate notices out.
Document	openCalendarEntryDocument(Database dbMail, String uid, String recurId, Collection<CalendarDocumentOpen> flags) This is a method to get a document for an entry on the calendar. The intent is that the note handle can be used to get information about an entry or instance or to write additional information to the entry or instance (beyond what is defined in iCalendar and/or available in this API).
String	readCalendarEntry(Database dbMail, String uid, String recurId, Collection<CalendarRead> flags) This will return complete iCalendar data for the specified entry. For recurring entries, this may result in multiple VEVENTs in the returned iCalendar data. In this case, the first VEVENT represents the recurrence set and additional entries represent exceptions to the recurrence set. All instances that differ from the recurrence set will be returned as additional VEVENTs containing the exceptional data.
String	readNotice(Database dbMail, int noteId, Collection<CalendarRead> flags) This will return iCalendar data representing a notice with the specified NOTIED. A notice may not yet be applied to the calendar entries itself, but an application may want to read the notice (and process it). Examples of notices include invitations, reschedules, information updates, confirmations, cancelations, counterproposals, requests for information, acceptances, declines, tenative acceptances, etc.
String	readNotice(Database dbMail, String unid, Collection<CalendarRead> flags) This will return iCalendar data representing a notice with the specified NOTIED. A notice may not yet be applied to the calendar entries itself, but an application may want to read the notice (and process it). Examples of notices include invitations, reschedules, information updates, confirmations, cancelations, counterproposals, requests for information, acceptances, declines, tenative acceptances, etc.
void	readRange(Database dbMail, TemporalAccessor start, TemporalAccessor end, Appendable retICal, List<String> retUIDs) Gets a summary of calendar entries for a range of times
void	readRange(Database dbMail, TemporalAccessor start, TemporalAccessor end, int skipCount, int maxRead, Appendable retICal, List<String> retUIDs) Gets a summary of calendar entries for a range of times
void	readRange(Database dbMail, TemporalAccessor start, TemporalAccessor end, int skipCount, int maxRead, Collection<CalendarReadRange> readMask, Appendable retICal, List<String> retUIDs) Gets a summary of calendar entries for a range of times
void	updateCalendarEntry(Database dbMail, String iCal, String uid, String recurId, String comments, Collection<CalendarWrite> flags) This will modify an existing calendar entry. This supports either single entries or recurring entries, but recurring entries will only support updates for a single instance specified via RECURRENCE-ID that may not include a RANGE (This may be permitted in the future but for now will return an error). The iCalendar input may only contain a single VEVENT and must contain a UID. By default, attachments and custom data (for fields contained in $CSCopyItems) will be maintained from the existing calendar entry.

Method Detail

createCalendarEntry

String createCalendarEntry(Database dbMail,
                           String iCal,
                           Collection<CalendarWrite> flags)

Creates a calendar entry.

This supports either a single entry, or a recurring entry which may contain multiple VEVENTS represenging both the series and exception data. The iCalendar input must only contain data for a single UID.For meetings, ATTENDEE PARTSTAT data is ignored.
If the mailfile owner is the meeting organizer, invitations will be sent out to meeting participants (unless CalendarWrite.DISABLE_IMPLICIT_SCHEDULING is specified) The following errors will be thrown by this method:

• NOERROR - on success
• ERR_NULL_DBHANDLE - The database handle is NULL
• ERR_MISC_INVALID_ARGS - Unexpected arguments provided
• ERR_NO_CALENDAR_FOUND - Unable to find the entry because the required view does not exist in this database
• ERR_EXISTS An entry already exists
• ERR_CS_PROFILE_NOOWNER - Calendar Profile does not specify owner
• ERR_UNEXPECTED_METHOD - Provided iCalendar contains a method (no method expected here)
• ERR_ICAL2NOTE_CONVERT - Error interpreting iCalendar input
• ERR_MISC_UNEXPECTED_ERROR - Unexpected internal error
• ERR_IMPLICIT_SCHED_FAILED - Entry was updated, but errors were encountered sending notices to meeting participants

Parameters:

dbMail - The database where the entry will be created.

iCal - The iCalendar data representing the entry to create

flags - CalendarWrite flags to control non-default behavior

Returns:

the UID of the created iCalendar, or an empty string if it could not be created

updateCalendarEntry

void updateCalendarEntry(Database dbMail,
                         String iCal,
                         String uid,
                         String recurId,
                         String comments,
                         Collection<CalendarWrite> flags)

This will modify an existing calendar entry.

This supports either single entries or recurring entries, but recurring entries will only support updates for a single instance specified via RECURRENCE-ID that may not include a RANGE (This may be permitted in the future but for now will return an error).

The iCalendar input may only contain a single VEVENT and must contain a UID.
By default, attachments and custom data (for fields contained in $CSCopyItems) will be maintained from the existing calendar entry. Similarly, description will also be maintained if it is not specified in the iCalendar content that is updating.

Both of these behaviors can be canceled via the CAL_WRITE_COMPLETE_REPLACE flag.
If the mailfile owner is the meeting organizer, appropriate notices will be sent out to meeting participants (unless CalendarWrite.DISABLE_IMPLICIT_SCHEDULING is specified).

The following errors will be thrown by this method:

• NOERROR - on success
• ERR_NULL_DBHANDLE - The database handle is NULL
• ERR_MISC_INVALID_ARGS - Unexpected arguments provided
• ERR_CALACTION_INVALID - This calendar entry is not in a state where updating it is supported.
• ERR_NO_CALENDAR_FOUND - Unable to find the entry because the required view does not exist in this database
• ERR_NOT_FOUND - There are no entries that match the specified UID or UID/recurid in the database
• ERR_NOT_YET_IMPLEMENTED - This update is not yet supported (update range or multiple VEVENTs?)
• ERR_CS_PROFILE_NOOWNER - Calendar Profile does not specify owner
• ERR_UNEXPECTED_METHOD - Provided iCalendar contains a method (no method expected here)
• ERR_ICAL2NOTE_OUTOFDATE - iCalendar input is out of date in regards to sequence information.
• ERR_ICAL2NOTE_CONVERT - Error interpereting iCalendar input
• ERR_MISC_UNEXPECTED_ERROR - Unexpected internal error
• ERR_IMPLICIT_SCHED_FAILED - Entry was updated, but errors were encountered sending notices to meeting participants

Parameters:

dbMail - The database containing the entry to update

iCal - The iCalendar data representing the updated entry

uid - If non-NULL, this value MUST match the UID value in the iCalendar input. If present,or else this returns ERR_InvalidVEventPropertyFound. If the iCalendar input has no UID this value will be used.

recurId - If non-NULL, this value MUST match the RECURRENCE-ID value in the iCalendar input if present, or else this returns ERR_InvalidVEventPropertyFound. If the iCalendar input has no RECURRENCE-ID this value will be used.

comments - If non-NULL, this text will be sent as comments on any notices sent to meeting participants as a result of this call. that will be included on the notices. Can be NULL.

flags - CalendarWrite flags to control non-default behavior. Supported: CAL_WRITE_MODIFY_LITERAL, CalendarWrite.DISABLE_IMPLICIT_SCHEDULING, CalendarWrite.IGNORE_VERIFY_DB.

getUIDfromDocument

String getUIDfromDocument(Document document)

This is a convinience method that returns a UID for a calendar entry document.
NOTEID->UID is a many to one mapping since one or several documents may represent a calendar entry (especially if it repeats) and its related notices.
As such, the UID output will be the same for all documents that refer to the same calendar entry.
This method may incur a document open, so there could be a performance impact.
The following errors will be thrown by this method:

• NOERROR - on success
• ERR_NULL_DBHANDLE - The database handle is NULL
• ERR_INVALID_NOTE - Note is not valid or is not a calendar note
• ERR_MISC_INVALID_ARGS - Unexpected arguments provided
• ERR_VALUE_LENGTH - The value is too long for the allocated buffer

Parameters:

document - the document

Returns:

UID

getUIDfromNoteID

String getUIDfromNoteID(Database dbMail,
                        int noteId)

This is a convinience method that returns a UID from a NOTEID.
NOTEID->UID is a many to one mapping since one or several notes may represent a calendar entry (especially if it repeats) and its related notices.
As such, the UID output will be the same for all notes that refer to the same calendar entry.
This method may incur a note open, so there could be performance impact.
The following errors will be thrown by this method:

• NOERROR - on success
• ERR_NULL_DBHANDLE - The database handle is NULL
• ERR_INVALID_NOTE - Note is not valid or is not a calendar note
• ERR_MISC_INVALID_ARGS - Unexpected arguments provided
• ERR_VALUE_LENGTH - The value is too long for the allocated buffer

Parameters:

dbMail - The database containing the note referenced by noteid.

noteId - note id

Returns:

UID

getUIDFromUNID

String getUIDFromUNID(Database dbMail,
                      String unid)

This is a convinience method that returns a UID from a UNID.

UNID->UID is a many to one mapping since one or several notes may represent a calendar entry (especially if it repeats) and its related notices.
As such, the UID output will be the same for all notes that refer to the same calendar entry.
This method may incur a note open, so there could be performance impact.
The following errors will be thrown by this method:

• NOERROR - on success
• ERR_NULL_DBHANDLE - The database handle is NULL
• ERR_INVALID_NOTE - Note is not valid or is not a calendar note
• ERR_MISC_INVALID_ARGS - Unexpected arguments provided
• ERR_VALUE_LENGTH - The value is too long for the allocated buffer

Parameters:

dbMail - The database containing the note referenced by unid.

unid - UNID of a calendar note

Returns:

UID

getApptUnidFromUID

String getApptUnidFromUID(String uid)

This is a convenience method that returns an Apptunid value that corresponds to a UID.

Parameters:

uid - UID of the icalendar entry

Returns:

ApptUnid

openCalendarEntryDocument

Document openCalendarEntryDocument(Database dbMail,
                                   String uid,
                                   String recurId,
                                   Collection<CalendarDocumentOpen> flags)

This is a method to get a document for an entry on the calendar.

The intent is that the note handle can be used to get information about an entry or instance or to write additional information to the entry or instance (beyond what is defined in iCalendar and/or available in this API). When opening a recurring entry, a valid recurrence ID MUST also be provided.

A note representing the single instance will be returned. This might cause notes to be created or modified as a side effect.
The following errors will be thrown by this method:

• NOERROR - on success
• ERR_NULL_DBHANDLE - The database handle is NULL
• ERR_NO_CALENDAR_FOUND - Unable to find the entry because the required view does not exist in this database
• ERR_NOT_FOUND - There are no entries that match the specified UID or UID/recurid in the database
• ERR_MISC_INVALID_ARGS - Unexpected arguments provided
• ERR_TDI_CONV - The recurrence ID specified cannot be interpreted
• ERR_MISC_UNEXPECTED_ERROR - Unexpected internal error

Parameters:

dbMail - The database containing the entry to open.

uid - The UID of the entry to get a note handle for.

recurId - The RECURRENCE-ID of the instance to get a note handle for. Timezones not permitted (time values must be in UTC time). NULL for single entries. Must be present for recurring entries.

flags - CalendarDocumentOpen flags to control non-default behavior. Supported: CalendarDocumentOpen.HANDLE_NOSPLIT.

Returns:

note

readCalendarEntry

String readCalendarEntry(Database dbMail,
                         String uid,
                         String recurId,
                         Collection<CalendarRead> flags)

This will return complete iCalendar data for the specified entry.

For recurring entries, this may result in multiple VEVENTs in the returned iCalendar data.
In this case, the first VEVENT represents the recurrence set and additional entries represent exceptions to the recurrence set.

All instances that differ from the recurrence set will be returned as additional VEVENTs containing the exceptional data. There is no concept of 'runs' of instances or RANGE of instances.
Alternatively, a specific instance may be requested using recurId and only the data for that instance will be returned.
Returned data will not include rich text description.
All participants of a meeting will be returned as PARTSTAT=NEEDS-ACTION even if they have responded.

Parameters:

dbMail - The database from which entries are returned.

uid - The UID of the entry to be returned.

recurId - NULL for single entries or to read data for an entire recurring series. If populated, this is the RECURRENCE-ID of the specific instance to read.

flags - CalendarRead flags to control non-default behavior

Returns:

iCalendar data

readRange

void readRange(Database dbMail,
               TemporalAccessor start,
               TemporalAccessor end,
               Appendable retICal,
               List<String> retUIDs)
        throws IOException

Gets a summary of calendar entries for a range of times

Parameters:

dbMail - The database from which entries are returned.

start - the start time of the range

end - the end time of the range. An exception occurs if the end time is not greater than the start time

retICal - if not null, we return a summary in iCalendar format of the entries from the start date to the end date, inclusive. An exception occurs if the range contains no entries.

retUIDs - if not null, we return a list of UIDs found within the range

Throws:

IOException - if writing iCalendar data fails

readRange

void readRange(Database dbMail,
               TemporalAccessor start,
               TemporalAccessor end,
               int skipCount,
               int maxRead,
               Appendable retICal,
               List<String> retUIDs)
        throws IOException

Gets a summary of calendar entries for a range of times

Parameters:

dbMail - The database from which entries are returned.

start - the start time of the range

end - the end time of the range. An exception occurs if the end time is not greater than the start time

skipCount - the number of entries to skip from the beginning of the range. This parameter can be used in conjunction with entriesprocessed to read the entries in a series of calls

maxRead - the maximum number of entries to read

retICal - if not null, we return a summary in iCalendar format of the entries from the start date to the end date, inclusive. An exception occurs if the range contains no entries.

retUIDs - if not null, we return a list of UIDs found within the range

Throws:

IOException - if writing iCalendar data fails

readRange

void readRange(Database dbMail,
               TemporalAccessor start,
               TemporalAccessor end,
               int skipCount,
               int maxRead,
               Collection<CalendarReadRange> readMask,
               Appendable retICal,
               List<String> retUIDs)
        throws IOException

Gets a summary of calendar entries for a range of times

Parameters:

dbMail - The database from which entries are returned.

start - the start time of the range

end - the end time of the range. An exception occurs if the end time is not greater than the start time

skipCount - the number of entries to skip from the beginning of the range. This parameter can be used in conjunction with entriesprocessed to read the entries in a series of calls

maxRead - the maximum number of entries to read

readMask - flags that control what properties about the calendar entries will be returned

retICal - if not null, we return a summary in iCalendar format of the entries from the start date to the end date, inclusive. An exception occurs if the range contains no entries.

retUIDs - if not null, we return a list of UIDs found within the range

Throws:

IOException - if writing iCalendar data fails

getRecurrenceID

String getRecurrenceID(TemporalAccessor td)

This is a convenience method that returns a RECURRENCE-ID (in UTC time) from a TemporalAccessor object.

Parameters:

td - Input time/date object

Returns:

RECURRENCE-ID

getUnappliedNotices

int getUnappliedNotices(Database dbMail,
                        String uid,
                        List<Integer> retNoteIds,
                        List<String> retUNIDs)

Retrieve the unapplied notices that exist for a participant of calendar entry representing a meeting.

This will return things like: Reschedules, informational updates, cancelations, confirmations, etc.

Notices will only be returned if the initial invitation has already been responded to, otherwise this method will return ERR_INVITE_NOT_ACCEPTED.

For recurring meetings, notices that apply to any instances in the series will be returned, with the exception of instances where the initial invitation has not yet been responded to.

Calendar entries that are not meetings will return ERR_INVALID_NOTE.

We do not currently support getting unprocessed calendar entries if you are the owner (such as a counter proposal request or a request for updated information), so this will return ERR_NOT_YET_IMPLEMENTED.

Note: For recurring meetings, it is possible that multiple notices will contain current information for a particular occurence, so it is not possible to guarantee that there is a single "most current" notice.

For example, the subject might be changed for a single instance, and then the time may be changed across instances.

Because only one notice will have the current subject and another notice will have the current time but NOT the current subject, both notices will be returned and both must be processed to guarantee accuracy.

Process returned notices via the CalNoticeAction method.

Parameters:

dbMail - The database to search for calendar entries

uid - The UID of the entry to return notices for.

retNoteIds - return list of note ids or NULL

retUNIDs - return list of UNIDs or NULL

Returns:

number of notices

getNewInvitations

int getNewInvitations(Database dbMail,
                      TemporalAccessor start,
                      String uid,
                      TemporalAccessor since,
                      AtomicReference<DominoDateTime> retUntil,
                      List<Integer> retNoteIds,
                      List<String> retUNIDs)

Retrieve invitations in a mailfile that have not yet been responded to.

This returns the number of new invitations as well as optional NOTEID and/or UNID lists.
This returns only invitations (and delegated invitations), and not reschedules, information updates, cancels, etc.

This method does not filter out any invitations that have since been canceled/rescheduled, or are otherwise out of date.

Once the invitation is accepted, other notices that apply to that meeting can be discovered with a call to getUnappliedNotices(Database, String, List, List) must be used (on a per-UID level).
Only invitations for meetings that are current (at least one instance starts within the last day or in the future) are returned, although the starting time can be specified by the caller to override the default.A caller can retrieve only invitations that have arrived since a prior call to getNewInvitations(com.hcl.domino.data.Database, java.time.temporal.TemporalAccessor, java.lang.String, java.time.temporal.TemporalAccessor, java.util.concurrent.atomic.AtomicReference<com.hcl.domino.data.DominoDateTime>, java.util.List<java.lang.Integer>, java.util.List<java.lang.String>) by using tdSince and ptdretUntil.If uid is provided, invitations only for a particular meeting will be returned.

This is useful if you are looking for an invitation or invitations that correspond to an updated notice that has arrived.

Note: Multiple invitations might exist for a particular UID if that meeting is recurring and you were added to an instance or instances after the initial creation.
The returned notices are not guaranteed to be in any particular order.

Parameters:

dbMail - The database from which entries are returned.

start - Optional: If provided, only invitations for meetings that occur on or after this time will be returned.Passing in NULL will use the default value (one day before current time).

uid - Optional: If present only invitations with a matching UID will be returned. Note: For some repeating meetings there could be multiple invites for the same UID (for separate instances).

since - Optional: Only return invitations that have been received/modified since the provided time.Passing in NULL will return invitations regardless of when they arrived.

retUntil - Optional: If provided, this is populated with the time of this method call, which can then be used as the ptdSince argument of a subsequent call.

retNoteIds - return list of note ids or NULL

retUNIDs - return list of UNIDs or NULL

Returns:

number of invitations

readNotice

String readNotice(Database dbMail,
                  int noteId,
                  Collection<CalendarRead> flags)

This will return iCalendar data representing a notice with the specified NOTIED.

A notice may not yet be applied to the calendar entries itself, but an application may want to read the notice (and process it).

Examples of notices include invitations, reschedules, information updates, confirmations, cancelations, counterproposals, requests for information, acceptances, declines, tenative acceptances, etc.

Parameters:

dbMail - The database from which entries are returned.

noteId - The NOTEID of the notice to be returned.

flags - CalendarRead flags to control non-default behavior. Supported: CalendarRead.HIDE_X_LOTUS, CalendarRead.INCLUDE_X_LOTUS.

Returns:

iCalendar data

readNotice

String readNotice(Database dbMail,
                  String unid,
                  Collection<CalendarRead> flags)

This will return iCalendar data representing a notice with the specified NOTIED.

A notice may not yet be applied to the calendar entries itself, but an application may want to read the notice (and process it).

Examples of notices include invitations, reschedules, information updates, confirmations, cancelations, counterproposals, requests for information, acceptances, declines, tenative acceptances, etc.

Parameters:

dbMail - The database from which entries are returned.

unid - The UNID of the notice to be returned.

flags - CalendarRead flags to control non-default behavior. Supported: CalendarRead.HIDE_X_LOTUS, CalendarRead.INCLUDE_X_LOTUS.

Returns:

iCalendar data

entryAction

void entryAction(Database dbMail,
                 String uid,
                 String recurId,
                 Collection<CalendarProcess> action,
                 CalendarRangeRepeat scope,
                 String comment,
                 CalendarActionData data,
                 Collection<CalendarActionOptions> flags)

Perform an action on a calendar entry.

For instance, change the response of an accepted meeting to counter or delegate.
This must be applied to meetings (with the exception of CalendarProcess.DELETE, which can be applied to any calendar entry).
This makes the appropriate modifications to the invitee calendar and also sends appropriate notices out.

Parameters:

dbMail - The database containing calendar entries to act on

uid - The UID of the entry to act on

recurId - The RECURRENCE-ID of the instance to act on. May be specified for recurring meetings (omission acts on all). MUST be NULL for single meetings. Timezones not permitted (time values must be in UTC time)

action - The action to perform as defined in CalendarProcess values

scope - CalendarRangeRepeat as defined above (ignored for non-repeating entries)

comment - Comments to include on the outgoing notice(s) to organizer or participants (can be NULL).

data - Conveys any additional information required to perform action - NULL for actions that do not require additional information to perform, required for CalendarProcess.DELEGATE, CalendarProcess.DECLINE and CalendarProcess.COUNTER and CalendarProcess.UPDATEINVITEES.

flags - Flags - Only CalendarActionOptions.UPDATE_ALL_PARTICIPANTS is allowed (and only for CalendarProcess.UPDATEINVITEES

noticeAction

void noticeAction(Database dbMail,
                  int noteId,
                  Collection<CalendarProcess> action,
                  String comment,
                  CalendarActionData data,
                  Collection<CalendarActionOptions> flags)

Process a calendar notice.
This makes the appropriate modifications to the calendar entry and also sends appropriate notices out.

Parameters:

dbMail - The database containing the notice to act on.

noteId - The noteid of the notice to act on.

action - The action to perform as defined in CalendarProcess values.

comment - Comments to include on the outgoing notice(s) to organizer or participants (can be NULL).

data - Conveys any additional information required to perform action - NULL for actions that do not require additional information to perform, required for CalendarProcess.DELEGATE and CalendarProcess.COUNTER

flags - Flags - (a CalendarActionOptions value).

noticeAction

void noticeAction(Database dbMail,
                  String unid,
                  Collection<CalendarProcess> action,
                  String comment,
                  CalendarActionData data,
                  Collection<CalendarActionOptions> flags)

Process a calendar notice.
This makes the appropriate modifications to the calendar entry and also sends appropriate notices out.

Parameters:

dbMail - The database containing the notice to act on.

unid - The UNID of the notice to act on

action - The action to perform as defined in CalendarProcess values.

comment - Comments to include on the outgoing notice(s) to organizer or participants (can be NULL).

data - Conveys any additional information required to perform action - NULL for actions that do not require additional information to perform, required for CalendarProcess.DELEGATE and CalendarProcess.COUNTER

flags - Flags - (a CalendarActionOptions value).

buildActionData

CalendarActionData buildActionData()

Use this method to start building the data object to be passed along calendar actions;

Returns:

the data instance