OSID Logo
OSID Specifications
recognition package
Version 3.1.0
Interfaceosid.recognition.AcademySearch
Implementsosid.OsidSearch
Used Byosid.recognition.AcademySearchSession
Description

The search interface for governing academy searches.

MethodsearchAmongAcademies
Description

Execute this search among the given list of academies.

Parametersosid.id.IdListacademyIds list of academies
ErrorsNULL_ARGUMENT academyIds is null
Compliancemandatory This method must be implemented.
MethodorderAcademyResults
Description

Specify an ordering to the search results.

Parametersosid.recognition.AcademySearchOrderacademysearchOrder academy search order
ErrorsNULL_ARGUMENT academysearchOrder is null
UNSUPPORTED academysearchOrder is not of this service
Compliancemandatory This 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.TypeacademySearchRecordType an academy search record type
Returnosid.recognition.records.AcademySearchRecord the academy search record
ErrorsNULL_ARGUMENT academysearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(academysearchRecordType) is false
Compliancemandatory This method must be implemented.