public interface ProfileEntryEnablerSearchSession extends ProfileEntryEnablerQuerySession
This session provides methods for searching among
ProfileEntryEnabler
objects. The search query is constructed using
the ProfileEntryEnableryQuery.
getProfileEntryEnablersByQuery()
is the basic search
method and returns a list of ProfileEntryEnablers.
A more
advanced search may be performed with
getProfileEntryEnablersBySearch().
It accepts a
ProfileEntryEnablerSearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
ordering. getProfileEntryEnablersBySearch()
returns a
ProfileEntryEnablerSearchResults
that can be used to access
the resulting ProfileEntryEnablerList
or be used to perform
a search within the result set through ProfileEntryEnablerSearch.
This session defines views that offer differing behaviors for searching.
ProfileEntryEnablers
may have a query record indicated
by their respective record types. The query record is accessed via the
ProfileEntryEnablerQuery.
Modifier and Type | Method and Description |
---|---|
ProfileEntryEnablerQuery |
getProfileEntryEnablerQueryFromInspector(ProfileEntryEnablerQueryInspector profileEntryEnablerQueryInspector)
Gets a profile entry enabler query from an inspector.
|
ProfileEntryEnablerSearchResults |
getProfileEntryEnablersBySearch(ProfileEntryEnablerQuery profileEntryEnablerQuery,
ProfileEntryEnablerSearch profileEntryEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
ProfileEntryEnablerSearch |
getProfileEntryEnablerSearch()
Gets a profile entry enabler search.
|
ProfileEntryEnablerSearchOrder |
getProfileEntryEnablerSearchOrder()
Gets a profile entry enabler search order.
|
canSearchProfileEntryEnablers, getProfile, getProfileEntryEnablerQuery, getProfileEntryEnablersByQuery, getProfileId, useFederatedProfileView, useIsolatedProfileView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ProfileEntryEnablerSearch getProfileEntryEnablerSearch()
mandatory
- This method must be implemented. ProfileEntryEnablerSearchOrder getProfileEntryEnablerSearchOrder()
ProfileEntryEnablerSearchOrder
is supplied to a
ProfileEntryEnablerSearch
to specify the ordering of results.mandatory
- This method must be implemented. ProfileEntryEnablerSearchResults getProfileEntryEnablersBySearch(ProfileEntryEnablerQuery profileEntryEnablerQuery, ProfileEntryEnablerSearch profileEntryEnablerSearch) throws OperationFailedException, PermissionDeniedException
profileEntryEnablerQuery
- the profile entry enabler queryprofileEntryEnablerSearch
- the profile entry enabler searchNullArgumentException
- profileEntryEnablerQuery
or profileEntryEnablerSearch
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- profileEntryEnablerQuery
or profileEntryEnablerSearch
is not of
this servicemandatory
- This method must be implemented. ProfileEntryEnablerQuery getProfileEntryEnablerQueryFromInspector(ProfileEntryEnablerQueryInspector profileEntryEnablerQueryInspector)
ProfileEntryEnablerSearchResults.
profileEntryEnablerQueryInspector
- a profile entry enabler
query inspectorNullArgumentException
-
profileEntryEnablerQueryInspector
is null
UnsupportedException
-
profileEntryEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.