OSID Logo
OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.CampusQuerySession
Implementsosid.OsidSession
Description

This session provides methods for searching Campus objects. The search query is constructed using the CampusQuery. The campus record Type also specifies the record for the campus query.

Campuses may have a query record indicated by their respective record types. The query record is accessed via the CampusQuery. The returns in this session may not be cast directly to these interfaces.

MethodcanSearchCampuses
Description

Tests if this user can perform Campus searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCampusQuery
Description

Gets a campus query.

Returnosid.room.CampusQuerythe campus query
CompliancemandatoryThis method must be implemented.
MethodgetCampusesByQuery
Description

Gets a list of Campuses matching the given campus query.

Parametersosid.room.CampusQuerycampusQuerythe campus query
Returnosid.room.CampusListthe returned CampusList
ErrorsNULL_ARGUMENT campusQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED campusQuery is not of this service
CompliancemandatoryThis method must be implemented.