OSID Logo
OSID Specifications
authorization package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.AuthorizationSearchSession
Implementsosid.authorization.AuthorizationQuerySession
Description

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.

  • federated view: searches include authorizations in Vaults of which this vault is a ancestor in the vault hierarchy
  • isolated view: searches are restricted to authorizations in this Vault
  • implicit authorization view: authorizations include implicit authorizations
  • explicit authorization view: only explicit authorizations are returned
MethodgetAuthorizationSearch
Description

Gets an authorization search.

Returnosid.authorization.AuthorizationSearchthe authorization search
CompliancemandatoryThis method must be implemented.
MethodgetAuthorizationSearchOrder
Description

Gets an authorization search order. The AuthorizationSearchOrder is supplied to an AuthorizationSearch to specify the ordering of results.

Returnosid.authorization.AuthorizationSearchOrderthe authorization search order
CompliancemandatoryThis method must be implemented.
MethodgetAuthorizationsBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.authorization.AuthorizationQueryauthorizationQuerythe authorization query
osid.authorization.AuthorizationSearchauthorizationSearchthe authorization search
Returnosid.authorization.AuthorizationSearchResultsthe returned search results
ErrorsNULL_ARGUMENT authorizationQuery or authorizationSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED authorizationSearch or authorizationQuery is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAuthorizationQueryFromInspector
Description

Gets an authorization query from an inspector. The inspector is available from an AuthorizationSearchResults.

Parametersosid.authorization.AuthorizationQueryInspectorauthorizationQueryInspectoran authorization query inspector
Returnosid.authorization.AuthorizationQuerythe authorization query
ErrorsNULL_ARGUMENT authorizationQueryInspector is null
UNSUPPORTED authorizationQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.