public interface PersonSearchSession extends PersonQuerySession
This session provides methods for searching Person
objects. The search query is constructed using the PersonQuery.
The person record Type
also specifies the record
for the person query.
getPersonsByQuery()
is the basic search method and
returns a list of Person
elements. A more advanced search
may be performed with getPersonsBySearch().
It accepts a
PersonSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getPersonsBySearch()
returns a
PersonSearchResults
that can be used to access the resulting
PersonList
or be used to perform a search within the result
set through PersonSearch.
This session defines views that offer differing behaviors for searching.
Persons may have a query record indicated by their respective record
types. The query record is accessed via the PersonQuery.
The returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
PersonQuery |
getPersonQueryFromInspector(PersonQueryInspector personQueryInspector)
Gets a person query from an inspector.
|
PersonSearchResults |
getPersonsBySearch(PersonQuery personQuery,
PersonSearch personSearch)
Gets the search results matching the given search.
|
PersonSearch |
getPersonSearch()
Gets a person search.
|
PersonSearchOrder |
getPersonSearchOrder()
Gets a person search order.
|
canSearchPersons, getPersonQuery, getPersonsByQuery, getRealm, getRealmId, useFederatedRealmView, useIsolatedRealmView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
PersonSearch getPersonSearch()
mandatory
- This method must be implemented. PersonSearchOrder getPersonSearchOrder()
PersonSearchOrder
is
supplied to a PersonSearch
to specify the ordering of
results.mandatory
- This method must be implemented. PersonSearchResults getPersonsBySearch(PersonQuery personQuery, PersonSearch personSearch) throws OperationFailedException, PermissionDeniedException
personQuery
- the person querypersonSearch
- the person searchNullArgumentException
- personQuery
or
personSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- personQuery
or
personSearch
is not of this servicemandatory
- This method must be implemented. PersonQuery getPersonQueryFromInspector(PersonQueryInspector personQueryInspector)
PersonSearchResults.
personQueryInspector
- a person query inspectorNullArgumentException
- personQueryInspector
is null
UnsupportedException
- personQueryInspector
is not of this servicemandatory
- This method must be implemented.