OSID Logo
OSID Specifications
authorization package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.QualifierSearchSession
Implementsosid.authorization.QualifierQuerySession
Description

This session provides methods for searching among Qualifier objects. The search query is constructed using the QualifierQuery. If more than one search element is specified within a single QualifierQuery, these elements form a boolean AND.

getQualifiersByQuery() is the basic search method and returns a list of Qualifiers. A more advanced search may be performed with getQualifiersBySearch(). It accepts a QualifierSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getQualifiersBySearch() returns a QualifierSearchResults that can be used to access the resulting QualifierList or be used to perform a search within the result set through QualifierSearch.

This session defines views that offer differing behaviors for searching.

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

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

MethodgetQualifierSearch
Description

Gets a qualifier search.

Returnosid.authorization.QualifierSearchthe qualifier search
CompliancemandatoryThis method must be implemented.
MethodgetQualifierSearchOrder
Description

Gets a qualifier search order. The QualifierSearchOrder is supplied to a QualifierSearch to specify the ordering of results.

Returnosid.authorization.QualifierSearchOrderthe qualifier search order
CompliancemandatoryThis method must be implemented.
MethodgetQualifiersBySearch
Description

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

Parametersosid.authorization.QualifierQueryqualifierQuerythe qualifier query
osid.authorization.QualifierSearchqualifierSearchthe qualifier search
Returnosid.authorization.QualifierSearchResultsthe search results
ErrorsNULL_ARGUMENT qualifierQueriy or qualifierSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED qualifierQuery or qualifierSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetQualifierQueryFromInspector
Description

Gets a qualifier query from an inspector. The inspector is available from a QualifierSearchResults.

Parametersosid.authorization.QualifierQueryInspectorqualifierQueryInspectora qualifier query inspector
Returnosid.authorization.QualifierQuerythe qualifier query
ErrorsNULL_ARGUMENT qualifierQueryInspector is null
UNSUPPORTED qualifierQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.