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

The search interface for governing academy searches.

MethodsearchAmongAcademies
Description

Execute this search among the given list of academies.

Parametersosid.id.IdListacademyIdslist of academies
ErrorsNULL_ARGUMENT academyIds is null
CompliancemandatoryThis method must be implemented.
MethodorderAcademyResults
Description

Specify an ordering to the search results.

Parametersosid.recognition.AcademySearchOrderacademysearchOrderacademy search order
ErrorsNULL_ARGUMENT academysearchOrder is null
UNSUPPORTED academysearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAcademySearchRecord
Description

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

Parametersosid.type.TypeacademySearchRecordTypean academy search record type
Returnosid.recognition.records.AcademySearchRecordthe academy search record
ErrorsNULL_ARGUMENT academysearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(academysearchRecordType) is false
CompliancemandatoryThis method must be implemented.