com.hcl.domino.data

Enum Database.DocFlags

java.lang.Object

java.lang.Enum<Database.DocFlags>

com.hcl.domino.data.Database.DocFlags

All Implemented Interfaces:

Serializable, Comparable<Database.DocFlags>

Enclosing interface:

Database

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
Match matches formula
NoAccess if there is reader's field at doc level this is the return value so that we could mark the replication as incomplete
NoMatch does not match formula (deleted or updated)
NoPurgeStatus note has no purge status.
Purged note has been purged.
SoftDeleted if DirectorySearchQuery.SearchFlag.NOTIFYDELETIONS: note is soft deleted; NoteClass & DocumentClass.NOTIFYDELETION also on (off for hard delete)
Truncated document truncated
TruncatedAttachments note has truncated attachments.

Method Summary

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

NoMatch

public static final Database.DocFlags NoMatch

does not match formula (deleted or updated)

Match

public static final Database.DocFlags Match

matches formula

Truncated

public static final Database.DocFlags Truncated

document truncated

Purged

public static final Database.DocFlags Purged

note has been purged. Returned only when SEARCH_INCLUDE_PURGED is used

NoPurgeStatus

public static final Database.DocFlags NoPurgeStatus

note has no purge status. Returned only when SEARCH_FULL_DATACUTOFF is used

SoftDeleted

public static final Database.DocFlags SoftDeleted

if DirectorySearchQuery.SearchFlag.NOTIFYDELETIONS: note is soft deleted; NoteClass & DocumentClass.NOTIFYDELETION also on (off for hard delete)

NoAccess

public static final Database.DocFlags NoAccess

if there is reader's field at doc level this is the return value so that we could mark the replication as incomplete

TruncatedAttachments

public static final Database.DocFlags TruncatedAttachments

note has truncated attachments. Returned only when SEARCH1_ONLY_ABSTRACTS is used

Method Detail

values

public static Database.DocFlags[] 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.DocFlags c : Database.DocFlags.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.DocFlags 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