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

This session provides methods for searching Renovation objects. The search query is constructed using the RenovationQuery. The renovation record Type also specifies the record for the renovation query.

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

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
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchRenovations
Description

Tests if this user can perform Renovation 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.
MethoduseFederatedCampusView
Description

Federates the view for methods in this session. A federated view will include renovations in campuses which are children of this campus in the campus hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCampusView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this campus only.

CompliancemandatoryThis method is must be implemented.
MethodgetRenovationQuery
Description

Gets a renovation query.

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

Gets a list of Renovations matching the given renovation query.

Parametersosid.room.construction.RenovationQueryrenovationQuerythe renovation query
Returnosid.room.construction.RenovationListthe returned RenovationList
ErrorsNULL_ARGUMENT renovationQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED renovationQuery is not of this service
CompliancemandatoryThis method must be implemented.