com.hcl.domino.keep.dbrequests

Enum KeepJnxSession.DocumentScope

java.lang.Object

java.lang.Enum<KeepJnxSession.DocumentScope>

com.hcl.domino.keep.dbrequests.KeepJnxSession.DocumentScope

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<KeepJnxSession.DocumentScope>

Enclosing class:

KeepJnxSession

public static enum KeepJnxSession.DocumentScope
extends java.lang.Enum<KeepJnxSession.DocumentScope>

Options to deal with getDocumentbyXX(…) to allow inclusion or exclusion of deleted documents. Mostly relevant in PIM where users mistake their Trash folder for a storage facility

Enum Constant Summary

Enum Constants

Enum Constant and Description
INCLUDE_DELETED Return current and (soft) deleted documents
UNDELETE_IF_FOUND Include (soft) deleted documents and undelete them if found
VALID_DOCUMENTS_ONLY Only return valid documents

Method Summary

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

INCLUDE_DELETED

public static final KeepJnxSession.DocumentScope INCLUDE_DELETED

Return current and (soft) deleted documents

VALID_DOCUMENTS_ONLY

public static final KeepJnxSession.DocumentScope VALID_DOCUMENTS_ONLY

Only return valid documents

UNDELETE_IF_FOUND

public static final KeepJnxSession.DocumentScope UNDELETE_IF_FOUND

Include (soft) deleted documents and undelete them if found

Method Detail

values

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

Returns:

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

valueOf

public static KeepJnxSession.DocumentScope valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null