OSID Logo
OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.ConvocationSearch
Implementsosid.OsidSearch
Description

The search interface for governing convocation searches.

MethodsearchAmongConvocations
Description

Execute this search among the given list of convocations.

Parametersosid.id.IdListconvocationIdslist of convocations
ErrorsNULL_ARGUMENT convocationIds is null
CompliancemandatoryThis method must be implemented.
MethodorderConvocationResults
Description

Specify an ordering to the search results.

Parametersosid.recognition.ConvocationSearchOrderconvocationSearchOrderconvocation search order
ErrorsNULL_ARGUMENT convocationSearchOrder is null
UNSUPPORTED convocationSearchOrder is not of this service
CompliancemandatoryThis 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.TypeconvocationSearchRecordTypea convocation search record type
Returnosid.recognition.records.ConvocationSearchRecordthe convocation search record
ErrorsNULL_ARGUMENT convocationSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(convocationSearchRecordType) is false
CompliancemandatoryThis method must be implemented.