public interface ProfileSearchSession extends ProfileQuerySession
This session provides methods for searching among Profile
objects. The search query is constructed using the
ProfileQuery.
getProfilesByQuery()
is the basic search method and
returns a list of Profile
objects.A more advanced search
may be performed with getProfilesBySearch().
It accepts a
ProfileSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getProfilesBySearch()
returns a
ProfileSearchResults
that can be used to access the resulting
ProfileList
or be used to perform a search within the
result set through ProfileSearch.
Profiles may have a profile query record indicated by their respective
record types. The profile query record is accessed via the
ProfileQuery.
Modifier and Type | Method and Description |
---|---|
ProfileQuery |
getProfileQueryFromInspector(ProfileQueryInspector profileQueryInspector)
Gets a profile query from an inspector.
|
ProfileSearchResults |
getProfilesBySearch(ProfileQuery profileQuery,
ProfileSearch profileSearch)
Gets the search results matching the given search query using the
given search.
|
ProfileSearch |
getProfileSearch()
Gets a profile search.
|
ProfileSearchOrder |
getProfileSearchOrder()
Gets a profile search order.
|
canSearchProfiles, getProfileQuery, getProfilesByQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ProfileSearch getProfileSearch()
mandatory
- This method must be implemented. ProfileSearchOrder getProfileSearchOrder()
ProfileSearchOrder
is
supplied to a ProfileSearch
to specify the ordering of
results.mandatory
- This method must be implemented. ProfileSearchResults getProfilesBySearch(ProfileQuery profileQuery, ProfileSearch profileSearch) throws OperationFailedException, PermissionDeniedException
profileQuery
- the profile queryprofileSearch
- the profile searchNullArgumentException
- profileQuery
or
profileSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- profileQuery
or
profileSearch
is not of this servicemandatory
- This method must be implemented. ProfileQuery getProfileQueryFromInspector(ProfileQueryInspector profileQueryInspector)
ProfileSearchResults.
profileQueryInspector
- a profile query inspectorNullArgumentException
- profileQueryInspector
is null
UnsupportedException
- profileQueryInspector
is not of this servicemandatory
- This method must be implemented.