OSID Logo
OSID Specifications
recognition package
Version 3.1.0
Interfaceosid.recognition.ConvocationSearch
Implementsosid.OsidSearch
Used Byosid.recognition.ConvocationSearchSession
Description

The search interface for governing convocation searches.

MethodsearchAmongConvocations
Description

Execute this search among the given list of convocations.

Parametersosid.id.IdListconvocationIds list of convocations
ErrorsNULL_ARGUMENT convocationIds is null
Compliancemandatory This method must be implemented.
MethodorderConvocationResults
Description

Specify an ordering to the search results.

Parametersosid.recognition.ConvocationSearchOrderconvocationSearchOrder convocation search order
ErrorsNULL_ARGUMENT convocationSearchOrder is null
UNSUPPORTED convocationSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetConvocationSearchRecord
Description

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

Parametersosid.type.TypeconvocationSearchRecordType a convocation search record type
Returnosid.recognition.records.ConvocationSearchRecord the convocation search record
ErrorsNULL_ARGUMENT convocationSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(convocationSearchRecordType) is false
Compliancemandatory This method must be implemented.