OSID Logo
OSID Specifications
authorization rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.rules.AuthorizationEnablerSearchSession
Implementsosid.authorization.rules.AuthorizationEnablerQuerySession
Description

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.

  • federated vault view: searches include authorization enablers in vaults of which this vault is an ancestor in the vault hierarchy
  • isolated vault view: searches are restricted to authorization enablers in this vault

AuthorizationEnablers may have a query record indicated by their respective record types. The query record is accessed via the AuthorizationEnablerQuery.

MethodgetAuthorizationEnablerSearch
Description

Gets an authorization enabler search.

Returnosid.authorization.rules.AuthorizationEnablerSearchthe authorization enabler search
CompliancemandatoryThis method must be implemented.
MethodgetAuthorizationEnablerSearchOrder
Description

Gets an authorization enabler search order. The AuthorizationEnablerSearchOrder is supplied to an AuthorizationEnablerSearch to specify the ordering of results.

Returnosid.authorization.rules.AuthorizationEnablerSearchOrderthe authorization enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetAuthorizationEnablersBySearch
Description

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

Parametersosid.authorization.rules.AuthorizationEnablerQueryauthorizationEnablerQuerythe authorization enabler query
osid.authorization.rules.AuthorizationEnablerSearchauthorizationEnablerSearchthe authorization enabler search
Returnosid.authorization.rules.AuthorizationEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT authorizationEnablerQuery or authorizationEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED authorizationEnablerQuery or authorizationEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAuthorizationEnablerQueryFromInspector
Description

Gets an authorization enabler query from an inspector. The inspector is available from an AuthorizationEnablerSearchResults.

Parametersosid.authorization.rules.AuthorizationEnablerQueryInspectorauthorizationEnablerQueryInspectoran authorization enabler query inspector
Returnosid.authorization.rules.AuthorizationEnablerQuerythe authorization enabler query
ErrorsNULL_ARGUMENT authorizationEnablerQueryInspector is null
UNSUPPORTED authorizationEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.