com.hcl.domino.dbdirectory

Enum DirectorySearchQuery.SearchFlag

java.lang.Object

java.lang.Enum<DirectorySearchQuery.SearchFlag>

com.hcl.domino.dbdirectory.DirectorySearchQuery.SearchFlag

All Implemented Interfaces:

Serializable, Comparable<DirectorySearchQuery.SearchFlag>

Enclosing interface:

DirectorySearchQuery

public static enum DirectorySearchQuery.SearchFlag
extends Enum<DirectorySearchQuery.SearchFlag>

Flags to control result of the Database.queryDQL(com.hcl.domino.dql.DQL.DQLTerm). These values can be bitwise ORed together to combine functionality. Note: The values are directly taken from

Author:

Karsten Lehmann

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_VERSIONS Include deleted and non-matching notes in search (ALWAYS "ON" in partial searches, which are searches using a since date!)
ALLCHILDREN Search includes all children of matching documents.
ALLDESCENDANTS Search includes all descendants of matching documents.
ALLPRIVS return error if we don't have full privileges
DATAONLY_FORMULA Search formula applies only to data notes, i.e., others match
FILETYPE For directory mode file type filtering.
FULL_DATACUTOFF Full search (as if Since was "1") but exclude DATA notes prior to passed-in Since time
NAMED_GHOSTS Include *** ALL *** named ghost notes in the search (profile docs, xACL's, etc).
NOABSTRACTS Filter out "Truncated" documents
NOITEMNAMES by using this search option combined with a map of (key=programmatic column name, value=column formula) entries, the NSF search function just returns these specified column values instead of the whole note's summary buffer.
NONREPLICATABLE INCLUDE notes with non-replicatable OID flag
NOPRIVCHECK Allow search to return id's only i.e.
NOTIFYDELETIONS Set NOTE_CLASS_NOTIFYDELETION bit of NoteClass for deleted notes
ONLYPROTECTED Return only docs with protection fields (BS_PROTECTED set in note header)
PROFILE_DOCS Include profile documents (a specific type of named ghost note) in the search Note: set SELECT_NAMED_GHOSTS, too, if you want the selection formula to be applied to the profile docs (so as not to get them all back as matches).
SELECT_NAMED_GHOSTS flag to let the selection formula be run against profile documents; must be used together with PROFILE_DOCS
SESSION_USERNAME Use current session's user name, not server's
SOFTDELETIONS Return soft deleted documents
SUMMARY TRUE to return summary buffer with each match

Method Summary

Modifier and Type	Method and Description
int	getValue()
static short	toBitMaskSearch1Flags(Collection<DirectorySearchQuery.SearchFlag> searchFlagSet)
static int	toBitMaskStdFlagsInt(Collection<DirectorySearchQuery.SearchFlag> searchFlagSet)
static DirectorySearchQuery.SearchFlag	valueOf(String name) Returns the enum constant of this type with the specified name.
static DirectorySearchQuery.SearchFlag[]	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

ALL_VERSIONS

public static final DirectorySearchQuery.SearchFlag ALL_VERSIONS

Include deleted and non-matching notes in search (ALWAYS "ON" in partial searches, which are searches using a since date!)

SUMMARY

public static final DirectorySearchQuery.SearchFlag SUMMARY

TRUE to return summary buffer with each match

FILETYPE

public static final DirectorySearchQuery.SearchFlag FILETYPE

For directory mode file type filtering. If set, "NoteClassMask" is treated as a FILE_xxx mask for directory filtering

NOTIFYDELETIONS

public static final DirectorySearchQuery.SearchFlag NOTIFYDELETIONS

Set NOTE_CLASS_NOTIFYDELETION bit of NoteClass for deleted notes

NOITEMNAMES

public static final DirectorySearchQuery.SearchFlag NOITEMNAMES

by using this search option combined with a map of (key=programmatic column name, value=column formula) entries, the NSF search function just returns these specified column values instead of the whole note's summary buffer. This speeds up indexing, as Notes has to copy less data and less data needs to be parsed.

ALLPRIVS

public static final DirectorySearchQuery.SearchFlag ALLPRIVS

return error if we don't have full privileges

SESSION_USERNAME

public static final DirectorySearchQuery.SearchFlag SESSION_USERNAME

Use current session's user name, not server's

NOABSTRACTS

public static final DirectorySearchQuery.SearchFlag NOABSTRACTS

Filter out "Truncated" documents

DATAONLY_FORMULA

public static final DirectorySearchQuery.SearchFlag DATAONLY_FORMULA

Search formula applies only to data notes, i.e., others match

NONREPLICATABLE

public static final DirectorySearchQuery.SearchFlag NONREPLICATABLE

INCLUDE notes with non-replicatable OID flag

FULL_DATACUTOFF

public static final DirectorySearchQuery.SearchFlag FULL_DATACUTOFF

Full search (as if Since was "1") but exclude DATA notes prior to passed-in Since time

NOPRIVCHECK

public static final DirectorySearchQuery.SearchFlag NOPRIVCHECK

Allow search to return id's only i.e. no summary buffer

ALLCHILDREN

public static final DirectorySearchQuery.SearchFlag ALLCHILDREN

Search includes all children of matching documents.

ALLDESCENDANTS

public static final DirectorySearchQuery.SearchFlag ALLDESCENDANTS

Search includes all descendants of matching documents.

NAMED_GHOSTS

public static final DirectorySearchQuery.SearchFlag NAMED_GHOSTS

Include *** ALL *** named ghost notes in the search (profile docs, xACL's, etc). Note: use SEARCH1_PROFILE_DOCS, etc., introduced in R6, for finer control

ONLYPROTECTED

public static final DirectorySearchQuery.SearchFlag ONLYPROTECTED

Return only docs with protection fields (BS_PROTECTED set in note header)

SOFTDELETIONS

public static final DirectorySearchQuery.SearchFlag SOFTDELETIONS

Return soft deleted documents

SELECT_NAMED_GHOSTS

public static final DirectorySearchQuery.SearchFlag SELECT_NAMED_GHOSTS

flag to let the selection formula be run against profile documents; must be used together with PROFILE_DOCS

PROFILE_DOCS

public static final DirectorySearchQuery.SearchFlag PROFILE_DOCS

Include profile documents (a specific type of named ghost note) in the search Note: set SELECT_NAMED_GHOSTS, too, if you want the selection formula to be applied to the profile docs (so as not to get them all back as matches).

Method Detail

values

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

Returns:

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

valueOf

public static DirectorySearchQuery.SearchFlag 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 int getValue()

toBitMaskSearch1Flags

public static short toBitMaskSearch1Flags(Collection<DirectorySearchQuery.SearchFlag> searchFlagSet)

toBitMaskStdFlagsInt

public static int toBitMaskStdFlagsInt(Collection<DirectorySearchQuery.SearchFlag> searchFlagSet)