public interface AuthorizationEnablerSearchSession extends AuthorizationEnablerQuerySession
This session provides methods for searching among
AuthorizationEnabler
objects. The search query is constructed
using the AuthorizationEnableryQuery.
getAuthorizationEnablersByQuery()
is the basic search
method and returns a list of AuthorizationEnablers.
A more
advanced search may be performed with
getAuthorizationEnablersBySearch().
It accepts an
AuthorizationEnablerSearch
in addition to the query for the
purpose of specifying additional options affecting the entire search, such
as ordering. getAuthorizationEnablersBySearch()
returns an
AuthorizationEnablerSearchResults
that can be used to
access the resulting AuthorizationEnablerList
or be used to
perform a search within the result set through
AuthorizationEnablerSearch.
This session defines views that offer differing behaviors for searching.
AuthorizationEnablers
may have a query record indicated
by their respective record types. The query record is accessed via the
AuthorizationEnablerQuery.
Modifier and Type | Method and Description |
---|---|
AuthorizationEnablerQuery |
getAuthorizationEnablerQueryFromInspector(AuthorizationEnablerQueryInspector authorizationEnablerQueryInspector)
Gets an authorization enabler query from an inspector.
|
AuthorizationEnablerSearchResults |
getAuthorizationEnablersBySearch(AuthorizationEnablerQuery authorizationEnablerQuery,
AuthorizationEnablerSearch authorizationEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
AuthorizationEnablerSearch |
getAuthorizationEnablerSearch()
Gets an authorization enabler search.
|
AuthorizationEnablerSearchOrder |
getAuthorizationEnablerSearchOrder()
Gets an authorization enabler search order.
|
canSearchAuthorizationEnablers, getAuthorizationEnablerQuery, getAuthorizationEnablersByQuery, getVault, getVaultId, useFederatedVaultView, useIsolatedVaultView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AuthorizationEnablerSearch getAuthorizationEnablerSearch()
mandatory
- This method must be implemented. AuthorizationEnablerSearchOrder getAuthorizationEnablerSearchOrder()
AuthorizationEnablerSearchOrder
is supplied to an
AuthorizationEnablerSearch
to specify the ordering of results.mandatory
- This method must be implemented. AuthorizationEnablerSearchResults getAuthorizationEnablersBySearch(AuthorizationEnablerQuery authorizationEnablerQuery, AuthorizationEnablerSearch authorizationEnablerSearch) throws OperationFailedException, PermissionDeniedException
authorizationEnablerQuery
- the authorization enabler queryauthorizationEnablerSearch
- the authorization enabler searchNullArgumentException
-
authorizationEnablerQuery
or
authorizationEnablerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- authorizationEnablerQuery
or authorizationEnablerSearch
is not of
this servicemandatory
- This method must be implemented. AuthorizationEnablerQuery getAuthorizationEnablerQueryFromInspector(AuthorizationEnablerQueryInspector authorizationEnablerQueryInspector)
AuthorizationEnablerSearchResults.
authorizationEnablerQueryInspector
- an authorization enabler
query inspectorNullArgumentException
-
authorizationEnablerQueryInspector
is null
UnsupportedException
-
authorizationEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.