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

FunctionSearch defines the interface for specifying function search options.

MethodsearchAmongFunctions
Description

Execute this search among the given list of functions.

Parametersosid.id.IdListfunctionIdslist of functions
ErrorsNULL_ARGUMENT functionIds is null
CompliancemandatoryThis method must be implemented.
MethodorderFunctionResults
Description

Specify an ordering to the search results.

Parametersosid.authorization.FunctionSearchOrderfunctionSearchOrderfunction search order
ErrorsNULL_ARGUMENT functionSearchOrder is null
UNSUPPORTED functionSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetFunctionSearchRecord
Description

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

Parametersosid.type.TypefunctionSearchRecordTypea function search record type
Returnosid.authorization.records.FunctionSearchRecordthe function search record
ErrorsNULL_ARGUMENT functionSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(functionSearchRecordType) is false
CompliancemandatoryThis method must be implemented.