OSID Logo
OSID Specifications
room package
Version 3.1.0
Interfaceosid.room.CampusSearch
Implementsosid.OsidSearch
Used Byosid.room.CampusSearchSession
Description

The search interface for governing campus searches.

MethodsearchAmongCampuses
Description

Execute this search among the given list of campuses.

Parametersosid.id.IdListcampusIds list of campuses
ErrorsNULL_ARGUMENT campusIds is null
Compliancemandatory This method must be implemented.
MethodorderCampusResults
Description

Specify an ordering to the search results.

Parametersosid.room.CampusSearchOrdercampussearchOrder campus search order
ErrorsNULL_ARGUMENT campussearchOrder is null
UNSUPPORTED campussearchOrder is not of this service
Compliancemandatory This 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.TypecampusSearchRecordType a campus search record type
Returnosid.room.records.CampusSearchRecord the campus search record
ErrorsNULL_ARGUMENT campussearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(campussearchRecordType) is false
Compliancemandatory This method must be implemented.