OSID Logo
OSID Specifications
authorization package
Version 3.1.0
Interfaceosid.authorization.FunctionSearch
Implementsosid.OsidSearch
Used Byosid.authorization.FunctionSearchSession
Description

FunctionSearch defines the interface for specifying function search options.

MethodsearchAmongFunctions
Description

Execute this search among the given list of functions.

Parametersosid.id.IdListfunctionIds list of functions
ErrorsNULL_ARGUMENT functionIds is null
Compliancemandatory This method must be implemented.
MethodorderFunctionResults
Description

Specify an ordering to the search results.

Parametersosid.authorization.FunctionSearchOrderfunctionSearchOrder function search order
ErrorsNULL_ARGUMENT functionSearchOrder is null
UNSUPPORTED functionSearchOrder is not of this service
Compliancemandatory This 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.TypefunctionSearchRecordType a function search record type
Returnosid.authorization.records.FunctionSearchRecord the function search record
ErrorsNULL_ARGUMENT functionSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(functionSearchRecordType) is false
Compliancemandatory This method must be implemented.