com.hcl.domino.calendar

Enum CalendarWrite

java.lang.Object

java.lang.Enum<CalendarWrite>

com.hcl.domino.calendar.CalendarWrite

All Implemented Interfaces:

Serializable, Comparable<CalendarWrite>

public enum CalendarWrite
extends Enum<CalendarWrite>

Flags that control behavior of the calendar APIs - Used when APIS take iCalendar input to modify calendar data Note: The values of these constants are the very same constants used by the C-API.

Author:

Karsten Lehmann

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPLETEREPLACE Used when APIs modify entry data via CalUpdateEntry. This flag means that NO data is preserved from the original entry and the resulting entry is 100% a product of the iCalendar passed in. NOTE: When this flag is NOT used, some content may be preserved during an update if that particular content was not included in the iCalendar input. This includes: Body Attachments Custom data properties as specified in $CSCopyItems
DISABLE_IMPLICIT_SCHEDULING Used when APIs create or modify calendar entries where the organizer is the mailfile owner. When a calendar entry is modified with DISABLE_IMPLICIT_SCHEDULING set, no notices are sent (invites, updates, reschedules, cancels, etc) Note: This is not intended for cases where you are saving a meeting as a draft (since there is currently not a capability to then send it later.
IGNORE_VERIFY_DB Used when APIs create or modify entries on the calendar This will allow creation/modification of calendar entries, even if the database is not a mailfile
USE_ALARM_DEFAULTS By default, alarms will be created on calendar entries based on VALARM content of iCalendar input. Use of this flag will disregard VALARM information in the iCalendar and use the user's default alarm settings for created or updated entries.

Method Summary

Modifier and Type	Method and Description
int	getValue()
static int	toBitMask(Collection<CalendarWrite> findSet)
static CalendarWrite	valueOf(String name) Returns the enum constant of this type with the specified name.
static CalendarWrite[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

COMPLETEREPLACE

public static final CalendarWrite COMPLETEREPLACE

Used when APIs modify entry data via CalUpdateEntry.
This flag means that NO data is preserved from the original entry and the resulting entry is 100% a product of the iCalendar passed in.
NOTE: When this flag is NOT used, some content may be preserved during an update if that particular content was not included in the iCalendar input.
This includes:

• Body
• Attachments
• Custom data properties as specified in $CSCopyItems

DISABLE_IMPLICIT_SCHEDULING

public static final CalendarWrite DISABLE_IMPLICIT_SCHEDULING

Used when APIs create or modify calendar entries where the organizer is the mailfile owner.
When a calendar entry is modified with DISABLE_IMPLICIT_SCHEDULING set, no notices are sent (invites, updates, reschedules, cancels, etc)

Note: This is not intended for cases where you are saving a meeting as a draft (since there is currently not a capability to then send it later. It will also not allow some notices to go out but other notices not to go out (such as, send invites to added invitees but dont send updates to existing invitees).
Rather, this is targeted at callers that prefer to be responsible for sending out notices themselves through a separate mechanism

IGNORE_VERIFY_DB

public static final CalendarWrite IGNORE_VERIFY_DB

Used when APIs create or modify entries on the calendar
This will allow creation/modification of calendar entries, even if the database is not a mailfile

USE_ALARM_DEFAULTS

public static final CalendarWrite USE_ALARM_DEFAULTS

By default, alarms will be created on calendar entries based on VALARM content of iCalendar input.
Use of this flag will disregard VALARM information in the iCalendar and use the user's default alarm settings for created or updated entries.

Method Detail

values

public static CalendarWrite[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CalendarWrite c : CalendarWrite.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CalendarWrite valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

toBitMask

public static int toBitMask(Collection<CalendarWrite> findSet)