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

AuthorizationSearch defines the interface for specifying authorization search options.

MethodsearchAmongAuthorizations
Description

Execute this search among the given list of authorizations.

Parametersosid.id.IdListauthorizationIdslist of authorizations
ErrorsNULL_ARGUMENT authorizationIds is null
CompliancemandatoryThis method must be implemented.
MethodorderAuthorizationResults
Description

Specify an ordering to the search results.

Parametersosid.authorization.AuthorizationSearchOrderauthorizationSearchOrderauthorization search order
ErrorsNULL_ARGUMENT authorizationSearchOrder is null
UNSUPPORTED authorizationSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAuthorizationSearchRecord
Description

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

Parametersosid.type.TypeauthorizationSearchRecordTypean authorization search record type
Returnosid.authorization.records.AuthorizationSearchRecordthe authorization search record
ErrorsNULL_ARGUMENT authorizationSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(authorizationSearchRecordType) is false
CompliancemandatoryThis method must be implemented.