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

This session manages queries and sequencing to create "smart" dynamic catalogs. A ProjectQuery can be retrieved from this session and mapped to this Campus to create a virtual collection of Projects. The projects may be sequenced using the ProjectSearchOrder from this session.

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

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

Gets a project query.

Returnosid.room.construction.ProjectQuerythe project query
CompliancemandatoryThis method must be implemented.
MethodgetProjectSearchOrder
Description

Gets a project search order.

Returnosid.room.construction.ProjectSearchOrderthe project search order
CompliancemandatoryThis method must be implemented.
MethodapplyProjectQuery
Description

Applies a project query to this campus.

Parametersosid.room.construction.ProjectQueryprojectQuerythe project query
ErrorsNULL_ARGUMENT projectQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED projectQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectProjectQuery
Description

Gets a project query inspector for this campus.

Returnosid.room.construction.ProjectQueryInspectorthe project query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyProjectSequencing
Description

Applies a project search order to this campus.

Parametersosid.room.construction.ProjectSearchOrderprojectSearchOrderthe project search order
ErrorsNULL_ARGUMENT projectSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED projectSearchOrder did not originate from getProjectSearchOrder()
CompliancemandatoryThis method must be implemented.
MethodgetProjectQueryFromInspector
Description

Gets a project query from an inspector.

Parametersosid.room.construction.ProjectQueryInspectorprojectQueryInspectora query inspector
Returnosid.room.construction.ProjectQuerythe project query
ErrorsNULL_ARGUMENT projectQueryInspector is null
UNSUPPORTED projectQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.