Find (HCL Domino API 1.0.27-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<Find>
- - com.hcl.domino.data.Find

All Implemented Interfaces:

Serializable, Comparable<Find>
```
public enum Find
extends Enum<Find>
```
These flags are used by DominoCollection.getAllIdsByKey(Set, Object) to control how the collection is searched for the key. The flags, PARTIAL, CASE_INSENSITIVE, and ACCENT_INSENSITIVE should only be used for character data, since a "partial number" or "partial date" is not well defined.

The LESS_THAN and GREATER_THAN flags refer to the way the sorted column keys are ordered and displayed, not the way they compare with each other. LESS_THAN means "find the entry before" and GREATER_THAN means "find the entry after" a desired key. The LESS_THAN and GREATER_THAN flags will result in success if at least one key that is less than or greater than the specified key, respectively, is found.

If a FIRST_EQUAL or LAST_EQUAL comparison is specified and the number of matches is requested to be returned, then the number of entries which match the specified key will be returned. If a LESS_THAN or GREATER_THAN comparison is specified, then the number of matching entries cannot be requested.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ACCENT_INSENSITIVE` Search disregards diacritical marks.
`CASE_INSENSITIVE` Case insensitive ("tim" matches "Tim")
`EQUAL` Qualifies LESS_THAN and GREATER_THAN to mean LESS_THAN_OR_EQUAL and GREATER_THAN_OR_EQUAL
`FIRST_EQUAL` Find first entry equal to the key value (if more than one).
`GREATER_THAN` Find first entry greater than the key value.
`LAST_EQUAL` Find last entry equal to the key value (if more than one).
`LESS_THAN` Find last entry less than the key value.
`LIMIT_MATCHES` Limit number of matches returned
`MATCH_CATEGORYANDLEAF` Search key is a category with leaf entry so match the leaf as well (eg.
`MATCH_CATEGORYORLEAF` Search key is a category only and if no match then match on the leaf.
`MATCH_PRIVATE_ONLY` Return only entries which hNames would disallow (requires full access set)
`PARTIAL` Match only the initial characters ("T" matches "Tim", "i" does not match "Tim").
`RANGE_OVERLAP` Overlapping ranges match, and values within a range match.
`REFRESH_FIRST` If the collection needs it, call NIFUpdateCollection prior to find (NIFFindByKeyExtended2 only
`UPDATE_IF_NOT_FOUND` If key is not found, update collection and search again
`VIEW_SENSITIVE` Use the case and accent sensitivity flags specified in the view

Field Summary

Fields
Modifier and Type Field and Description

static short FIND_COMPARE_MASK
Bitmask of the comparison flags defined above

Fields
Modifier and Type	Field and Description
`static short`	`FIND_COMPARE_MASK` Bitmask of the comparison flags defined above

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getValue()`
`static short`	`toBitMask(Set<Find> findSet)`
`static int`	`toBitMaskInt(Set<Find> findSet)`
`static Find`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Find[]`	`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
  - PARTIAL
```
public static final Find PARTIAL
```
    Match only the initial characters ("T" matches "Tim", "i" does not match "Tim"). If multiple keys are used, a partial match is done on each of the keys in the order that they are specified. A partial match must be found for all specified keys in order for a particular entry to be considered a successful match.
  - CASE_INSENSITIVE
```
public static final Find CASE_INSENSITIVE
```
    Case insensitive ("tim" matches "Tim")
  - ACCENT_INSENSITIVE
```
public static final Find ACCENT_INSENSITIVE
```
    Search disregards diacritical marks.
  - UPDATE_IF_NOT_FOUND
```
public static final Find UPDATE_IF_NOT_FOUND
```
    If key is not found, update collection and search again
  - LESS_THAN
```
public static final Find LESS_THAN
```
    Find last entry less than the key value. (Specify no more than one of: LESS_THAN, FIRST_EQUAL, LAST_EQUAL, GREATER_THAN)
  - FIRST_EQUAL
```
public static final Find FIRST_EQUAL
```
    Find first entry equal to the key value (if more than one). This flag is the default. (Specify no more than one of: LESS_THAN, FIRST_EQUAL, LAST_EQUAL, GREATER_THAN)
  - LAST_EQUAL
```
public static final Find LAST_EQUAL
```
    Find last entry equal to the key value (if more than one). (Specify no more than one of: LESS_THAN, FIRST_EQUAL, LAST_EQUAL, GREATER_THAN)
  - GREATER_THAN
```
public static final Find GREATER_THAN
```
    Find first entry greater than the key value. (Specify no more than one of: LESS_THAN, FIRST_EQUAL, LAST_EQUAL, GREATER_THAN)
  - EQUAL
```
public static final Find EQUAL
```
    Qualifies LESS_THAN and GREATER_THAN to mean LESS_THAN_OR_EQUAL and GREATER_THAN_OR_EQUAL
  - RANGE_OVERLAP
```
public static final Find RANGE_OVERLAP
```
    Overlapping ranges match, and values within a range match. This symbol is valid for fields of type TYPE_TIME_RANGE and TYPE_NUMBER_RANGE. Therefore it should only be used with NIFFindByKey.
  - VIEW_SENSITIVE
```
public static final Find VIEW_SENSITIVE
```
    Use the case and accent sensitivity flags specified in the view
  - LIMIT_MATCHES
```
public static final Find LIMIT_MATCHES
```
    Limit number of matches returned
  - MATCH_CATEGORYANDLEAF
```
public static final Find MATCH_CATEGORYANDLEAF
```
    Search key is a category with leaf entry so match the leaf as well (eg. ibm\atlanta\joe blow
  - MATCH_CATEGORYORLEAF
```
public static final Find MATCH_CATEGORYORLEAF
```
    Search key is a category only and if no match then match on the leaf.
  - MATCH_PRIVATE_ONLY
```
public static final Find MATCH_PRIVATE_ONLY
```
    Return only entries which hNames would disallow (requires full access set)
  - REFRESH_FIRST
```
public static final Find REFRESH_FIRST
```
    If the collection needs it, call NIFUpdateCollection prior to find (NIFFindByKeyExtended2 only
- Field Detail
  - FIND_COMPARE_MASK
```
public static short FIND_COMPARE_MASK
```
    Bitmask of the comparison flags defined above
- Method Detail
  - values
```
public static Find[] 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 (Find c : Find.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Find 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()
```
  - toBitMask
```
public static short toBitMask(Set<Find> findSet)
```
  - toBitMaskInt
```
public static int toBitMaskInt(Set<Find> findSet)
```

Enum Find

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

PARTIAL

CASE_INSENSITIVE

ACCENT_INSENSITIVE

UPDATE_IF_NOT_FOUND

LESS_THAN

FIRST_EQUAL

LAST_EQUAL

GREATER_THAN

EQUAL

RANGE_OVERLAP

VIEW_SENSITIVE

LIMIT_MATCHES

MATCH_CATEGORYANDLEAF

MATCH_CATEGORYORLEAF

MATCH_PRIVATE_ONLY

REFRESH_FIRST

Field Detail

FIND_COMPARE_MASK

Method Detail

values

valueOf

getValue

toBitMask

toBitMaskInt