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

This session manages queries and sequencing to create "smart" dynamic catalogs. A LeaseQuery can be retrieved from this session and mapped to this Campus to create a virtual collection of Leases. The leases may be sequenced using the LeaseSearchOrder from this session.

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

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

Gets a lease query.

Returnosid.room.squatting.LeaseQuerythe lease query
CompliancemandatoryThis method must be implemented.
MethodgetLeaseSearchOrder
Description

Gets a lease search order.

Returnosid.room.squatting.LeaseSearchOrderthe lease search order
CompliancemandatoryThis method must be implemented.
MethodapplyLeaseQuery
Description

Applies a lease query to this campus.

Parametersosid.room.squatting.LeaseQueryleaseQuerythe lease query
ErrorsNULL_ARGUMENT leaseQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED leaseQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectLeaseQuery
Description

Gets a lease query inspector for this campus.

Returnosid.room.squatting.LeaseQueryInspectorthe lease query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyLeaseSequencing
Description

Applies a lease search order to this campus.

Parametersosid.room.squatting.LeaseSearchOrderleaseSearchOrderthe lease search order
ErrorsNULL_ARGUMENT leaseSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED leaseSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetLeaseQueryFromInspector
Description

Gets a lease query from an inspector.

Parametersosid.room.squatting.LeaseQueryInspectorleaseQueryInspectora query inspector
Returnosid.room.squatting.LeaseQuerythe lease query
ErrorsNULL_ARGUMENT leaseQueryInspector is null
UNSUPPORTED leaseQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.