Returns a set of groups from this realm that matches the search parameters.
Note: Searching is not case sensitive.
Note: If IBM Virtual Member Manager (VMM) or IBM Connections is configured as a directory service provider for
Content Platform Engine, this method will return only the first page of search results.
Note:If IBM Connections is configured as a directory service provider for Content Platform Engine,
then search type options are limited to the following values:
PrincipalSearchType.EXACT
or
PrincipalSearchType.PREFIX_MATCH.
The rules that govern the search behavior are:
- If sortType has a non-null value (not none), then
searchAttribute must also have a non-null value. (sortType
needs a value to sort on.)
- If either searchPattern or searchType has a
positive value (not empty or non-null, respectively), then searchPattern,
searchType, and searchAttribute must all have positive values.
Namespace:
FileNet.Api.Security
Assembly:
FileNet.Api (in FileNet.Api.dll)
JavaScript |
---|
function findGroups(searchPattern, searchType, searchAttribute, sortType, pageSize, filter); |
Parameters
- searchPattern
- Type: System..::.String
A String expression that specifies the string pattern used for the
search. Case does not matter.
- searchType
- Type: FileNet.Api.Constants..::.PrincipalSearchType
Specifies how the search pattern is applied; null indicates no
preference.
- searchAttribute
- Type: FileNet.Api.Constants..::.PrincipalSearchAttribute
Specifies the Group object property to use for the search;
null indicates none.
- sortType
- Type: FileNet.Api.Constants..::.PrincipalSearchSortType
Specifies the desired sorting; null indicates no sorting is
to be performed.
- pageSize
- Type: System..::.Nullable<(Of <(Int32>)>)
Specifies the size of each page of Group objects returned;
if null or zero (0), page size defaults to 499.
- filter
- Type: FileNet.Api.Property..::.PropertyFilter
A PropertyFilter object that represents information for
controlling which property values (and with what level of detail and recursion) to return.
If null, this method returns values for all non-object properties and returns
placeholders for all object-valued properties (PropertyEngineObject
properties with a state of PropertyState.UNEVALUATED or
PropertyState.REFERENCE); any subsequent attempts to access an object-valued
property will cause an automatic round-trip to the server to fetch its value.
Return Value
A
GroupSet object containing the
Group objects matching the search request.