public interface ProfileItemSearchSession extends ProfileItemQuerySession
This session provides methods for searching ProfileItem
objects. The search query is constructed using the
ProfileItemQuery.
The profile item record Type
also
specifies the query record for the profile item query.
getProfileItemsByQuery()
is the basic search method and
returns a list of ProfileItems.
A more advanced search may
be performed with getProfileItemsBySearch().
It accepts a
ProfileItemSearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
ordering. getProfileItemsBySearch()
returns an
ProfileItemSearchResults
that can be used to access the resulting
ProfileItemList
or be used to perform a search within the
result set through ProfileItemSearch.
This session defines views that offer differing behaviors for searching.
Profile items may have a profie item query record indicated by their
respective record types. The profile item query record is accessed via the
ProfileItemQuery.
Modifier and Type | Method and Description |
---|---|
ProfileItemQuery |
getProfileItemQueryFromInspector(ProfileItemQueryInspector profileItemQueryInspector)
Gets a profile item query from an inspector.
|
ProfileItemSearchResults |
getProfileItemsBySearch(ProfileItemQuery profileItemQuery,
ProfileItemSearch profileItemSearch)
Gets the search results matching the given search query using the
given search.
|
ProfileItemSearch |
getProfileItemSearch()
Gets a profile item search.
|
ProfileItemSearchOrder |
getProfileItemSearchOrder()
Gets a profile item search order.
|
canSearchProfileItems, getProfile, getProfileId, getProfileItemQuery, getProfileItemsByQuery, useFederatedProfileView, useIsolatedProfileView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ProfileItemSearch getProfileItemSearch()
mandatory
- This method must be implemented. ProfileItemSearchOrder getProfileItemSearchOrder()
ProfileItemSearchOrder
is supplied to a ProfileItemSearch
to specify
the ordering of results.mandatory
- This method must be implemented. ProfileItemSearchResults getProfileItemsBySearch(ProfileItemQuery profileItemQuery, ProfileItemSearch profileItemSearch) throws OperationFailedException, PermissionDeniedException
profileItemQuery
- the profile item queryprofileItemSearch
- the profile item searchNullArgumentException
- profileItemQuery
or profileItemSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- profileItemSearch
or profileItemQuery
is not of this servicemandatory
- This method must be implemented. ProfileItemQuery getProfileItemQueryFromInspector(ProfileItemQueryInspector profileItemQueryInspector)
ProfileItemSearchResults.
profileItemQueryInspector
- a profile item query inspectorNullArgumentException
-
profileItemQueryInspector
is null
UnsupportedException
- profileItemQueryInspector
is not of this servicemandatory
- This method must be implemented.