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

This session manages queries and sequencing to create "smart" dynamic catalogs. A RoomQuery can be retrieved from this session and mapped to this Campus to create a virtual collection of Rooms. The rooms may be sequenced using the RoomSearchOrder from this session.

This Campus has a default query that matches any room and a default search order that specifies no sequencing. The queries may be examined using a RoomQueryInspector. The query may be modified by converting the inspector back to a RoomQuery.

MethodgetCampusId
Description

Gets the Campus Id associated with this session.

Returnosid.id.Idthe Campus Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCampus
Description

Gets the Campus associated with this session.

Returnosid.room.Campusthe Campus associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartCampuses
Description

Tests if this user can manage smart campuses. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returnboolean false if smart campus management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRoomQuery
Description

Gets a room query.

Returnosid.room.RoomQuerythe room query
CompliancemandatoryThis method must be implemented.
MethodgetRoomSearchOrder
Description

Gets a room search order.

Returnosid.room.RoomSearchOrderthe room search order
CompliancemandatoryThis method must be implemented.
MethodapplyRoomQuery
Description

Applies a room query to this campus.

Parametersosid.room.RoomQueryroomQuerythe room query
ErrorsNULL_ARGUMENT roomQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED roomQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectRoomQuery
Description

Gets a room query inspector for this campus.

Returnosid.room.RoomQueryInspectorthe rooms query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyRoomSequencing
Description

Applies a room search order to this campus.

Parametersosid.room.RoomSearchOrderroomSearchOrderthe room search order
ErrorsNULL_ARGUMENT roomSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED roomSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRoomQueryFromInspector
Description

Gets a room query from an inspector.

Parametersosid.room.RoomQueryInspectorroomQueryInspectora query inspector
Returnosid.room.RoomQuerythe room query
ErrorsNULL_ARGUMENT roomQueryInspector is null
UNSUPPORTED roomQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.