com.hcl.domino.naming

Interface UserDirectoryQuery

All Superinterfaces:

SearchQuery

public interface UserDirectoryQuery
extends SearchQuery

Represents a query into the names directory system of the local runtime or a remote server.

Since:

1.0.2

Author:

Jesse Gallagher

Method Summary

Modifier and Type	Method and Description
UserDirectoryQuery	exhaustive() Sets the query to search through all available directories, rather than stopping with the first directory to contain a match.
UserDirectoryQuery	forceUpdate() Instructs the query to update the back-end views before performing the search.
UserDirectoryQuery	items(Collection<String> items) Specifies the items to extract from found directory entries.
default UserDirectoryQuery	items(String... items) Specifies the items to extract from found directory entries.
UserDirectoryQuery	names(Collection<String> names) Specifies the names to look up.
default UserDirectoryQuery	names(String... names) Specifies the names to look up.
UserDirectoryQuery	namespaces(Collection<String> namespaces) Instructs the query to search the provided namespaces, which in practice correspond to Domino view names.
default UserDirectoryQuery	namespaces(String... namespaces) Instructs the query to search the provided namespaces, which in practice correspond to Domino view names.
Stream<List<Map<String,List<Object>>>>	stream() Executes and retrieves a stream of results from the query.

Method Detail

exhaustive

UserDirectoryQuery exhaustive()

Sets the query to search through all available directories, rather than stopping with the first directory to contain a match.

Returns:

this query builder

forceUpdate

UserDirectoryQuery forceUpdate()

Instructs the query to update the back-end views before performing the search.

Returns:

this query builder

namespaces

UserDirectoryQuery namespaces(Collection<String> namespaces)

Instructs the query to search the provided namespaces, which in practice correspond to Domino view names. The default for this setting is to search "$Users".

If specified, this must be non-null and non-empty.

Parameters:

namespaces - a Collection of namespace names to search

Returns:

this query builder

namespaces

default UserDirectoryQuery namespaces(String... namespaces)

Instructs the query to search the provided namespaces, which in practice correspond to Domino view names. The default for this setting is to search "$Users".

Parameters:

namespaces - the namespaces names to search

Returns:

this query builder

Since:

1.0.17

names

UserDirectoryQuery names(Collection<String> names)

Specifies the names to look up. If unspecified, the query will return all entries in the specified namespaces.

Parameters:

names - a Collection of string names to look up

Returns:

this query builder

names

default UserDirectoryQuery names(String... names)

Specifies the names to look up. If unspecified, the query will return all entries in the specified namespaces.

Parameters:

names - the names to look up

Returns:

this query builder

Since:

1.0.17

items

UserDirectoryQuery items(Collection<String> items)

Specifies the items to extract from found directory entries.

This must be specified before a call to stream()

Parameters:

items - a Collection of item names

Returns:

this query builder

items

default UserDirectoryQuery items(String... items)

Specifies the items to extract from found directory entries.

This must be specified before a call to stream()

Parameters:

items - a Collection of item names

Returns:

this query builder

Since:

1.0.17

stream

Stream<List<Map<String,List<Object>>>> stream()

Executes and retrieves a stream of results from the query.

The result stream will contain one entry per queried name per queried namespace. Each of those entries will contain a list of matches for the name+namespace pair.

Returns:

a Stream of List<Map<String, Object>> lookup results for this query

Throws:

IllegalArgumentException - if items(Collection) has not been specified or if either it or namespaces(Collection) is set to null or empty