public interface AuthorizationSearchSession extends AuthorizationQuerySession
This session provides methods for searching Authorization
objects. The search query is constructed using the
AuthorizationQuery.
getAuthorizationsByQuery()
is the basic search method
and returns a list of Authorizations.
A more advanced
search may be performed with getAuthorizationsBySearch().
It accepts an AgentSearch
in addition to the query for the
purpose of specifying additional options affecting the entire search, such
as ordering. getAuthorizationssBySearch()
returns an
AuthorizationSearchResults
that can be used to access the
resulting AuthorizationList
or be used to perform a search
within the result set through AuthorizationSearch.
This session defines views that offer differing behaviors for searching.
Vaults
of which this vault is a ancestor in the vault hierarchy Vault
Modifier and Type | Method and Description |
---|---|
AuthorizationQuery |
getAuthorizationQueryFromInspector(AuthorizationQueryInspector authorizationQueryInspector)
Gets an authorization query from an inspector.
|
AuthorizationSearchResults |
getAuthorizationsBySearch(AuthorizationQuery authorizationQuery,
AuthorizationSearch authorizationSearch)
Gets the search results matching the given search query using the
given search.
|
AuthorizationSearch |
getAuthorizationSearch()
Gets an authorization search.
|
AuthorizationSearchOrder |
getAuthorizationSearchOrder()
Gets an authorization search order.
|
canSearchAuthorizations, getAuthorizationQuery, getAuthorizationsByQuery, getVault, getVaultId, useExplicitAuthorizationView, useFederatedVaultView, useImplicitAuthorizationView, useIsolatedVaultView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AuthorizationSearch getAuthorizationSearch()
mandatory
- This method must be implemented. AuthorizationSearchOrder getAuthorizationSearchOrder()
AuthorizationSearchOrder
is supplied to an
AuthorizationSearch
to specify the ordering of results.mandatory
- This method must be implemented. AuthorizationSearchResults getAuthorizationsBySearch(AuthorizationQuery authorizationQuery, AuthorizationSearch authorizationSearch) throws OperationFailedException, PermissionDeniedException
authorizationQuery
- the authorization queryauthorizationSearch
- the authorization searchNullArgumentException
- authorizationQuery
or authorizationSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- authorizationSearch
or authorizationQuery
is not of this
servicemandatory
- This method must be implemented. AuthorizationQuery getAuthorizationQueryFromInspector(AuthorizationQueryInspector authorizationQueryInspector)
AuthorizationSearchResults.
authorizationQueryInspector
- an authorization query inspectorNullArgumentException
-
authorizationQueryInspector
is null
UnsupportedException
-
authorizationQueryInspector
is not of this servicemandatory
- This method must be implemented.