com.hcl.domino.calendar

Enum CalendarDocumentOpen

java.lang.Object

java.lang.Enum<CalendarDocumentOpen>

com.hcl.domino.calendar.CalendarDocumentOpen

All Implemented Interfaces:

Serializable, Comparable<CalendarDocumentOpen>

public enum CalendarDocumentOpen
extends Enum<CalendarDocumentOpen>

Flags that control behavior of the calendar APIs - Used when opening a document for 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

HANDLE_NOSPLIT Used when getting a handle via CalOpenNoteHandle (Handy for read-only cases) When a specific instance of a recurring entry is requested, the underlying note may represent multiple instances. Default behavior makes appropriate modifications so that the returned handle represents a single instance (but this might cause notes to be created or modified as a side effect). Using HANDLE_NOSPLIT will bypass any note creations or modifications and return a note handle that may represent more than a single instance on the calendar.

Method Summary

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

HANDLE_NOSPLIT

public static final CalendarDocumentOpen HANDLE_NOSPLIT

Used when getting a handle via CalOpenNoteHandle (Handy for read-only cases)
When a specific instance of a recurring entry is requested, the underlying note may represent multiple instances.

Default behavior makes appropriate modifications so that the returned handle represents a single instance (but this might cause notes to be created or modified as a side effect).

Using HANDLE_NOSPLIT will bypass any note creations or modifications and return a note handle that may represent more than a single instance on the calendar.

Method Detail

values

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

Returns:

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

valueOf

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