OSID Logo
OSID Specifications
course requisite package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.requisite.RequisiteSearch
Implementsosid.OsidSearch
Description

The search interface for governing requisite searches.

MethodsearchAmongRequisites
Description

Execute this search among the given list of requisites.

Parametersosid.id.IdListrequisiteIdslist of requisite Ids
ErrorsNULL_ARGUMENT requisiteIds is null
CompliancemandatoryThis method must be implemented.
MethodorderRequisiteResults
Description

Specify an ordering to the search results.

Parametersosid.course.requisite.RequisiteSearchOrderrequisiteSearchOrderrequisite search order
ErrorsNULL_ARGUMENT requisiteSearchOrder is null
UNSUPPORTED requisiteSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRequisiteSearchRecord
Description

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

Parametersosid.type.TyperequisiteSearchRecordTypea requisite search record type
Returnosid.course.requisite.records.RequisiteSearchRecordthe requisite search record
ErrorsNULL_ARGUMENT requisiteSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(requisiteSearchRecordType) is false
CompliancemandatoryThis method must be implemented.