OSID Logo
OSID Specifications
authorization package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.QualifierSearch
Implementsosid.OsidSearch
Description

QualifierSearch defines the interface for specifying qualifier search options.

MethodsearchAmongQualifiers
Description

Execute this search among the given list of qualifiers.

Parametersosid.id.IdListqualifierIdslist of qualifiers
ErrorsNULL_ARGUMENT qualifierIds is null
CompliancemandatoryThis method must be implemented.
MethodorderQualifierResults
Description

Specify an ordering to the search results.

Parametersosid.authorization.QualifierSearchOrderqualifierSearchOrderqualifier search order
ErrorsNULL_ARGUMENT qualifierSearchOrder is null
UNSUPPORTED qualifierSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetQualifierSearchRecord
Description

Gets the qualifier search record corresponding to the given qualifier search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypequalifierSearchRecordTypea qualifier search record type
Returnosid.authorization.records.QualifierSearchRecordthe qualifier search record
ErrorsNULL_ARGUMENT qualifierSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(qualifierSearchRecordType) is false
CompliancemandatoryThis method must be implemented.