com.hcl.domino.calendar

Enum CalendarRead

java.lang.Object

java.lang.Enum<CalendarRead>

com.hcl.domino.calendar.CalendarRead

All Implemented Interfaces:

Serializable, Comparable<CalendarRead>

public enum CalendarRead
extends Enum<CalendarRead>

Flags that control behavior of the calendar APIs that return iCalendar data for an entry or notice 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
HIDE_X_LOTUS Used when APIs generate iCalendar By default, some X-LOTUS properties and parameters will be included in iCalendar data returned by these APIs. HIDE_X_LOTUS causes all X-LOTUS properties and parameters to be removed from the generated iCalendar data. Note: This overrides INCLUDE_X_LOTUS
INCLUDE_X_LOTUS Used when APIs generate iCalendar Include all Lotus specific properties like X-LOTUS-UPDATE-SEQ, X-LOTUS-UPDATE_WISL, etc in the generated iCalendar data. These properties are NOT included by default in any iCalendar data returned by the APIs. Caution: Unless the caller knows how to use these it can be dangerous since their presence will be honored and can cause issues if not updated properly. Ignored if HIDE_X_LOTUS is also specified.
SKIP_RESPONSE_DATA RESERVED: This functionality is not currently in plan When generating ATTENDEE info in Calendaring.readCalendarEntry(Database, String, String, Collection), determine and populate response Status (which might be a performance hit)

Method Summary

Modifier and Type	Method and Description
int	getValue()
static int	toBitMask(Collection<CalendarRead> findSet)
static CalendarRead	valueOf(String name) Returns the enum constant of this type with the specified name.
static CalendarRead[]	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

HIDE_X_LOTUS

public static final CalendarRead HIDE_X_LOTUS

Used when APIs generate iCalendar

By default, some X-LOTUS properties and parameters will be included in iCalendar data returned by these APIs.
HIDE_X_LOTUS causes all X-LOTUS properties and parameters to be removed from the generated iCalendar data.

Note: This overrides INCLUDE_X_LOTUS

INCLUDE_X_LOTUS

public static final CalendarRead INCLUDE_X_LOTUS

Used when APIs generate iCalendar

Include all Lotus specific properties like X-LOTUS-UPDATE-SEQ, X-LOTUS-UPDATE_WISL, etc in the generated iCalendar data.
These properties are NOT included by default in any iCalendar data returned by the APIs.

Caution: Unless the caller knows how to use these it can be dangerous since their presence will be honored and can cause issues if not updated properly.
Ignored if HIDE_X_LOTUS is also specified.

SKIP_RESPONSE_DATA

public static final CalendarRead SKIP_RESPONSE_DATA

RESERVED: This functionality is not currently in plan
When generating ATTENDEE info in Calendaring.readCalendarEntry(Database, String, String, Collection), determine and populate response Status (which might be a performance hit)

Method Detail

values

public static CalendarRead[] 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 (CalendarRead c : CalendarRead.values())
    System.out.println(c);

Returns:

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

valueOf

public static CalendarRead 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<CalendarRead> findSet)