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

This session manages queries and sequencing to create "smart" dynamic catalogs. A RenovationQuery can be retrieved from this session and mapped to this Campus to create a virtual collection of Renovations. The renovations may be sequenced using the RenovationSearchOrder from this session.

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

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.
MethodgetRenovationQuery
Description

Gets a renovation query.

Returnosid.room.construction.RenovationQuerythe renovation query
CompliancemandatoryThis method must be implemented.
MethodgetRenovationSearchOrder
Description

Gets a renovation search order.

Returnosid.room.construction.RenovationSearchOrderthe renovation search order
CompliancemandatoryThis method must be implemented.
MethodapplyRenovationQuery
Description

Applies a renovation query to this campus.

Parametersosid.room.construction.RenovationQueryrenovationQuerythe renovation query
ErrorsNULL_ARGUMENT renovationQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED renovationQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectRenovationQuery
Description

Gets a renovation query inspector for this campus.

Returnosid.room.construction.RenovationQueryInspectorthe renovation query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyRenovationSequencing
Description

Applies a renovation search order to this campus.

Parametersosid.room.construction.RenovationSearchOrderrenovationSearchOrderthe renovation search order
ErrorsNULL_ARGUMENT renovationSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED renovationSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRenovationQueryFromInspector
Description

Gets a renovation query from an inspector.

Parametersosid.room.construction.RenovationQueryInspectorrenovationQueryInspectora query inspector
Returnosid.room.construction.RenovationQuerythe renovation query
ErrorsNULL_ARGUMENT renovationQueryInspector is null
UNSUPPORTED renovationQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.