com.hcl.domino.admin.replication

Enum GetDocumentsMode

java.lang.Object

java.lang.Enum<GetDocumentsMode>

com.hcl.domino.admin.replication.GetDocumentsMode

All Implemented Interfaces:

INumberEnum<Integer>, Serializable, Comparable<GetDocumentsMode>

public enum GetDocumentsMode
extends Enum<GetDocumentsMode>
implements INumberEnum<Integer>

Control flags for NSFDbGetNotes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPLY_FOLDER_ADDS Apply folder ops directly - don't bother using callback
CONTINUE_ON_ERROR Continue to next on list if error encountered
GET_FOLDER_ADDS Enable folder-add callback function after the note-level callback
NO_STREAMING Don't stream - used primarily for testing purposes
ORDER_BY_SIZE Order returned notes by (approximate) ascending size
PRESERVE_ORDER Preserve order of notes in NoteID list
SEND_OBJECTS Send (copiable) objects along with note

Method Summary

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

PRESERVE_ORDER

public static final GetDocumentsMode PRESERVE_ORDER

Preserve order of notes in NoteID list

SEND_OBJECTS

public static final GetDocumentsMode SEND_OBJECTS

Send (copiable) objects along with note

ORDER_BY_SIZE

public static final GetDocumentsMode ORDER_BY_SIZE

Order returned notes by (approximate) ascending size

CONTINUE_ON_ERROR

public static final GetDocumentsMode CONTINUE_ON_ERROR

Continue to next on list if error encountered

GET_FOLDER_ADDS

public static final GetDocumentsMode GET_FOLDER_ADDS

Enable folder-add callback function after the note-level callback

APPLY_FOLDER_ADDS

public static final GetDocumentsMode APPLY_FOLDER_ADDS

Apply folder ops directly - don't bother using callback

NO_STREAMING

public static final GetDocumentsMode NO_STREAMING

Don't stream - used primarily for testing purposes

Method Detail

values

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

Returns:

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

valueOf

public static GetDocumentsMode 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 Integer getValue()

Specified by:

getValue in interface INumberEnum<Integer>

Returns:

the C-level value of the enum

getLongValue

public long getLongValue()

Specified by:

getLongValue in interface INumberEnum<Integer>

Returns:

the C-level value of the enum as a long