OSID Logo
OSID Specifications
authorization package
Version 3.1.0
Interfaceosid.authorization.QualifierSearch
Implementsosid.OsidSearch
Used Byosid.authorization.QualifierSearchSession
Description

QualifierSearch defines the interface for specifying qualifier search options.

MethodsearchAmongQualifiers
Description

Execute this search among the given list of qualifiers.

Parametersosid.id.IdListqualifierIds list of qualifiers
ErrorsNULL_ARGUMENT qualifierIds is null
Compliancemandatory This method must be implemented.
MethodorderQualifierResults
Description

Specify an ordering to the search results.

Parametersosid.authorization.QualifierSearchOrderqualifierSearchOrder qualifier search order
ErrorsNULL_ARGUMENT qualifierSearchOrder is null
UNSUPPORTED qualifierSearchOrder is not of this service
Compliancemandatory This 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.TypequalifierSearchRecordType a qualifier search record type
Returnosid.authorization.records.QualifierSearchRecord the qualifier search record
ErrorsNULL_ARGUMENT qualifierSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(qualifierSearchRecordType) is false
Compliancemandatory This method must be implemented.