OSID Logo
OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.CampusSearch
Implementsosid.OsidSearch
Description

The search interface for governing campus searches.

MethodsearchAmongCampuses
Description

Execute this search among the given list of campuses.

Parametersosid.id.IdListcampusIdslist of campuses
ErrorsNULL_ARGUMENT campusIds is null
CompliancemandatoryThis method must be implemented.
MethodorderCampusResults
Description

Specify an ordering to the search results.

Parametersosid.room.CampusSearchOrdercampussearchOrdercampus search order
ErrorsNULL_ARGUMENT campussearchOrder is null
UNSUPPORTED campussearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCampusSearchRecord
Description

Gets the campus search record corresponding to the given campus search record Type. This method must be used to retrieve an object implementing the requested record.

Parametersosid.type.TypecampusSearchRecordTypea campus search record type
Returnosid.room.records.CampusSearchRecordthe campus search record
ErrorsNULL_ARGUMENT campussearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(campussearchRecordType) is false
CompliancemandatoryThis method must be implemented.