com.hcl.domino.calendar

Enum CalendarReadRange

java.lang.Object

java.lang.Enum<CalendarReadRange>

com.hcl.domino.calendar.CalendarReadRange

All Implemented Interfaces:

Serializable, Comparable<CalendarReadRange>

public enum CalendarReadRange
extends Enum<CalendarReadRange>

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
ALARM Output alarm information for this entry
APPTTYPE
CATEGORY
CLASS
DTEND
DTSTAMP
DTSTART
HASATTACH X-LOTUS-HASATTACH is set to 1 if there are any file attachments for this entry
LOCATION
NOTESORGANIZER Note: For performance reasons, the organizer may not be stored in ORGANIZER but rather in X-LOTUS-ORGANIZER to avoid lookups necessary to get the internet address.
NOTESROOM Note: For performance reasons, the organizer may not be stored in PARTICIPANT but rather in X-LOTUS-ROOM to avoid lookups necessary to get the internet address.
NOTICETYPE
ONLINE_URL Includes online meeting URL as well as any online meeting password or conf ID
PRIORITY
RECURRENCE_ID
SEQUENCE
STATUS
SUMMARY
TRANSP
UNID X-LOTUS-UNID will always be set for notices (as it is used as the identifier for a notice), but setting this flag will also set X-LOTUS-UNID for calendar entries, where this will be set with the UNID of the note that currently contains this instance (can be used to construct a URL to open the instance in Notes, for instance)

Method Summary

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

DTSTART

public static final CalendarReadRange DTSTART

DTEND

public static final CalendarReadRange DTEND

DTSTAMP

public static final CalendarReadRange DTSTAMP

SUMMARY

public static final CalendarReadRange SUMMARY

CLASS

public static final CalendarReadRange CLASS

PRIORITY

public static final CalendarReadRange PRIORITY

RECURRENCE_ID

public static final CalendarReadRange RECURRENCE_ID

SEQUENCE

public static final CalendarReadRange SEQUENCE

LOCATION

public static final CalendarReadRange LOCATION

TRANSP

public static final CalendarReadRange TRANSP

CATEGORY

public static final CalendarReadRange CATEGORY

APPTTYPE

public static final CalendarReadRange APPTTYPE

NOTICETYPE

public static final CalendarReadRange NOTICETYPE

STATUS

public static final CalendarReadRange STATUS

ONLINE_URL

public static final CalendarReadRange ONLINE_URL

Includes online meeting URL as well as any online meeting password or conf ID

NOTESORGANIZER

public static final CalendarReadRange NOTESORGANIZER

Note: For performance reasons, the organizer may not be stored in ORGANIZER but rather in X-LOTUS-ORGANIZER to avoid lookups necessary to get the internet address.

NOTESROOM

public static final CalendarReadRange NOTESROOM

Note: For performance reasons, the organizer may not be stored in PARTICIPANT but rather in X-LOTUS-ROOM to avoid lookups necessary to get the internet address.

ALARM

public static final CalendarReadRange ALARM

Output alarm information for this entry

HASATTACH

public static final CalendarReadRange HASATTACH

X-LOTUS-HASATTACH is set to 1 if there are any file attachments for this entry

UNID

public static final CalendarReadRange UNID

X-LOTUS-UNID will always be set for notices (as it is used as the identifier for a notice), but setting this flag will also set X-LOTUS-UNID for calendar entries, where this will be set with the UNID of the note that currently contains this instance (can be used to construct a URL to open the instance in Notes, for instance)

Method Detail

values

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

Returns:

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

valueOf

public static CalendarReadRange 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

getMaskNr

public int getMaskNr()

getValue

public int getValue()

toBitMask

public static int toBitMask(Collection<CalendarReadRange> flagSet)

toBitMask2

public static int toBitMask2(Collection<CalendarReadRange> flagSet)