com.hcl.domino.data

Enum Database.OpenDocumentMode

java.lang.Object

java.lang.Enum<Database.OpenDocumentMode>

com.hcl.domino.data.Database.OpenDocumentMode

All Implemented Interfaces:

Serializable, Comparable<Database.OpenDocumentMode>

Enclosing interface:

Database

public static enum Database.OpenDocumentMode
extends Enum<Database.OpenDocumentMode>

Flags to control how to open a document.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABSTRACT_ONLY Only open an abstract of large documents
CACHE If specified, the open will check to see if this note had already been read and saved in memory.
CONVERT_MIME_TO_RICHTEXT Converts items of type ItemDataType.TYPE_MIME_PART to ItemDataType.TYPE_COMPOSITE (rich text).
CONVERT_RFC822_TO_TEXT_AND_TIME Converts items of type ItemDataType.TYPE_RFC822_TEXT to ItemDataType.TYPE_TEXT and ItemDataType.TYPE_TIME.
LOAD_RESPONSES Generate an ID Table of Note IDs for the responses to this note.
MARK_READ Mark unread to read if unread list is currently associated (database is a remote database).
NOOBJECTS Do not read any objects.
SUMMARY_ONLY open only summary info

Method Summary

Modifier and Type	Method and Description
static Database.OpenDocumentMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static Database.OpenDocumentMode[]	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

SUMMARY_ONLY

public static final Database.OpenDocumentMode SUMMARY_ONLY

open only summary info

MARK_READ

public static final Database.OpenDocumentMode MARK_READ

Mark unread to read if unread list is currently associated (database is a remote database).

ABSTRACT_ONLY

public static final Database.OpenDocumentMode ABSTRACT_ONLY

Only open an abstract of large documents

LOAD_RESPONSES

public static final Database.OpenDocumentMode LOAD_RESPONSES

Generate an ID Table of Note IDs for the responses to this note. Use this option in order to access the Note IDs of the immediate responses to a given note in a later call to NSFNoteGetInfo() using _NOTE_RESPONSES as the note header member ID.

CACHE

public static final Database.OpenDocumentMode CACHE

If specified, the open will check to see if this note had already been read and saved in memory. If not, and the database is server based, we will also check the on-disk cache. If the note is not found, it is cached in memory and at some time in the future commited to a local on disk cache.

The notes are guaranteed to be as up to date as the last time NSFValidateNoteCache was called. Minimally, this should be called the 1st time a database is opened prior to specifying this flag.

NOOBJECTS

public static final Database.OpenDocumentMode NOOBJECTS

Do not read any objects. Objects include file attachments and DDE links.
Warning: documents opened with OPEN_NOOBJECTS then subsequently updated loose all objects that were previously attached.

CONVERT_RFC822_TO_TEXT_AND_TIME

public static final Database.OpenDocumentMode CONVERT_RFC822_TO_TEXT_AND_TIME

Converts items of type ItemDataType.TYPE_RFC822_TEXT to ItemDataType.TYPE_TEXT and ItemDataType.TYPE_TIME. If not set, we leave the items in their native format.

CONVERT_MIME_TO_RICHTEXT

public static final Database.OpenDocumentMode CONVERT_MIME_TO_RICHTEXT

Converts items of type ItemDataType.TYPE_MIME_PART to ItemDataType.TYPE_COMPOSITE (rich text). If not set, we leave the items in their native format.

Method Detail

values

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

Returns:

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

valueOf

public static Database.OpenDocumentMode 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