Content Engine Java API: PrincipalSearchType

java.lang.Object
- com.filenet.api.constants.PrincipalSearchType

All Implemented Interfaces:

java.io.Serializable
```
public class PrincipalSearchType
extends java.lang.Object
implements java.io.Serializable
```
Determines which (if any) pattern-matching is used for a specified search pattern. This class is used by Realm.findUsers(java.lang.String, com.filenet.api.constants.PrincipalSearchType, com.filenet.api.constants.PrincipalSearchAttribute, com.filenet.api.constants.PrincipalSearchSortType, java.lang.Integer, com.filenet.api.property.PropertyFilter) and Realm.findGroups(java.lang.String, com.filenet.api.constants.PrincipalSearchType, com.filenet.api.constants.PrincipalSearchAttribute, com.filenet.api.constants.PrincipalSearchSortType, java.lang.Integer, com.filenet.api.property.PropertyFilter).
Note: If the Content Engine's directory service provider is configured for IBM Virtual Member Manager (VMM)with IBM Connections integration, then search type support is limited to the following values: PrincipalSearchType.EXACT or PrincipalSearchType.PREFIX_MATCH.

See Also:
Realm, PrincipalSearchAttribute, PrincipalSearchSortType, SQL Syntax Reference, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static PrincipalSearchType`	`CONTAINS` A constant representing a PrincipalSearchType instance of type CONTAINS.
`static int`	`CONTAINS_AS_INT` An integer associated with the CONTAINS instance of this class.
`static PrincipalSearchType`	`CUSTOM` A constant representing a PrincipalSearchType instance of type CUSTOM.
`static int`	`CUSTOM_AS_INT` An integer associated with the CUSTOM instance of this class.
`static PrincipalSearchType`	`EXACT` A constant representing a PrincipalSearchType instance of type EXACT.
`static int`	`EXACT_AS_INT` An integer associated with the EXACT instance of this class.
`static PrincipalSearchType`	`NONE` A constant representing a PrincipalSearchType instance of type NONE.
`static int`	`NONE_AS_INT` An integer associated with the NONE instance of this class.
`static PrincipalSearchType`	`PREFIX_MATCH` A constant representing a PrincipalSearchType instance of type PREFIX_MATCH.
`static int`	`PREFIX_MATCH_AS_INT` An integer associated with the PREFIX_MATCH instance of this class.
`static PrincipalSearchType`	`SUFFIX_MATCH` A constant representing a PrincipalSearchType instance of type SUFFIX_MATCH.
`static int`	`SUFFIX_MATCH_AS_INT` An integer associated with the SUFFIX_MATCH instance of this class.

Method Summary

Methods
Modifier and Type	Method and Description
`static PrincipalSearchType`	`getInstanceFromInt(int value)` Gets the instance of this class using its associated integer value (the *_AS_INT fields).
`int`	`getValue()` Returns an integer value associated with a specific instance of this class.
`java.lang.String`	`toString()` Returns a String representation of this instance.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NONE_AS_INT
```
public static final int NONE_AS_INT
```
    An integer associated with the NONE instance of this class.
    Use the static instances of this class, rather than the associated integer values. The integer values risk binary incompatibility (but not source incompatibility) across product releases.
    
    See Also:
    Constant Field Values
  - NONE
```
public static final PrincipalSearchType NONE
```
    A constant representing a PrincipalSearchType instance of type NONE. This specifies that no pattern matching is used for the search pattern.
    
    See Also:
    getValue(), getInstanceFromInt(int)
  - CUSTOM_AS_INT
```
public static final int CUSTOM_AS_INT
```
    An integer associated with the CUSTOM instance of this class.
    Use the static instances of this class, rather than the associated integer values. The integer values risk binary incompatibility (but not source incompatibility) across product releases.
    
    See Also:
    Constant Field Values
  - CUSTOM
```
public static final PrincipalSearchType CUSTOM
```
    A constant representing a PrincipalSearchType instance of type CUSTOM. This specifies that the caller has full control of the pattern matching used for the search pattern. For example, if specifying "*foo*" as a search pattern, the search criteria includes all names that contain "foo".
    
    See Also:
    getValue(), getInstanceFromInt(int)
  - PREFIX_MATCH_AS_INT
```
public static final int PREFIX_MATCH_AS_INT
```
    An integer associated with the PREFIX_MATCH instance of this class.
    Use the static instances of this class, rather than the associated integer values. The integer values risk binary incompatibility (but not source incompatibility) across product releases.
    
    See Also:
    Constant Field Values
  - PREFIX_MATCH
```
public static final PrincipalSearchType PREFIX_MATCH
```
    A constant representing a PrincipalSearchType instance of type PREFIX_MATCH. This specifies that prefix pattern matching is used for the search pattern. For example, if specifying "foo" as a search pattern, the search criteria includes all names that begin with "foo".
    
    See Also:
    getValue(), getInstanceFromInt(int)
  - SUFFIX_MATCH_AS_INT
```
public static final int SUFFIX_MATCH_AS_INT
```
    An integer associated with the SUFFIX_MATCH instance of this class.
    Use the static instances of this class, rather than the associated integer values. The integer values risk binary incompatibility (but not source incompatibility) across product releases.
    
    See Also:
    Constant Field Values
  - SUFFIX_MATCH
```
public static final PrincipalSearchType SUFFIX_MATCH
```
    A constant representing a PrincipalSearchType instance of type SUFFIX_MATCH. This specifies that suffix pattern matching is used for the search pattern. For example, if specifying "foo" as a search pattern, the search criteria includes all names that end with "foo".
    
    See Also:
    getValue(), getInstanceFromInt(int)
  - CONTAINS_AS_INT
```
public static final int CONTAINS_AS_INT
```
    An integer associated with the CONTAINS instance of this class.
    Use the static instances of this class, rather than the associated integer values. The integer values risk binary incompatibility (but not source incompatibility) across product releases.
    
    See Also:
    Constant Field Values
  - CONTAINS
```
public static final PrincipalSearchType CONTAINS
```
    A constant representing a PrincipalSearchType instance of type CONTAINS. This specifies that the search pattern must be contained in the search scope.
    
    See Also:
    getValue(), getInstanceFromInt(int)
  - EXACT_AS_INT
```
public static final int EXACT_AS_INT
```
    An integer associated with the EXACT instance of this class.
    Use the static instances of this class, rather than the associated integer values. The integer values risk binary incompatibility (but not source incompatibility) across product releases.
    
    See Also:
    Constant Field Values
  - EXACT
```
public static final PrincipalSearchType EXACT
```
    A constant representing a PrincipalSearchType instance of type EXACT. This specifies that the search pattern must be an exact match.
    
    See Also:
    getValue(), getInstanceFromInt(int)
- Method Detail
  - getValue
```
public int getValue()
```
    Returns an integer value associated with a specific instance of this class.
    
    Returns:
    An integer representing a specific instance of this class.
  - getInstanceFromInt
```
public static PrincipalSearchType getInstanceFromInt(int value)
```
    Gets the instance of this class using its associated integer value (the *_AS_INT fields).
    
    Parameters:
    value - An integer representing a particular static instance of this class.
    
    Returns:
    The PrincipalSearchType instance referenced.
    
    Throws:
    
    EngineRuntimeException - Thrown when the parameter is null.
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    A String representing the instance.

Methods inherited from class java.lang.Object

NONE_AS_INT

NONE

CUSTOM_AS_INT

CUSTOM

PREFIX_MATCH_AS_INT

PREFIX_MATCH

SUFFIX_MATCH_AS_INT

SUFFIX_MATCH

CONTAINS_AS_INT

CONTAINS

EXACT_AS_INT

EXACT

getValue

getInstanceFromInt

toString