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

This session provides methods to retrieve Building to Campus mappings. A Building may appear in multiple Campuses. Each Campus may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupBuildingCampusMappings
Description

Tests if this user can perform lookups of building/campus mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. This is intendedas a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeCampusView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryCampusView
Description

A complete view of the Building and Campus returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetBuildingIdsByCampus
Description

Gets the list of Building Ids associated with a Campus.

Parametersosid.id.IdcampusId Id of a Campus
Returnosid.id.IdListlist of related building Ids
ErrorsNOT_FOUND campusId is not found
NULL_ARGUMENT campusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBuildingsByCampus
Description

Gets the list of Buildings associated with a Campus.

Parametersosid.id.IdcampusId Id of a Campus
Returnosid.room.BuildingListlist of related buildings
ErrorsNOT_FOUND campusId is not found
NULL_ARGUMENT campusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBuildingIdsByCampuses
Description

Gets the list of Building Ids corresponding to a list of Campus objects.

Parametersosid.id.IdListcampusIdslist of campus Ids
Returnosid.id.IdListlist of building Ids
ErrorsNULL_ARGUMENT campusIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBuildingsByCampuses
Description

Gets the list of Buildings corresponding to a list of Campuses.

Parametersosid.id.IdListcampusIdslist of campus Ids
Returnosid.room.BuildingListlist of buildings
ErrorsNULL_ARGUMENT campusIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCampusIdsByBuilding
Description

Gets the list of Campus Ids mapped to a Building.

Parametersosid.id.IdbuildingId Id of a Building
Returnosid.id.IdListlist of campus Ids
ErrorsNOT_FOUND buildingId is not found
NULL_ARGUMENT buildingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCampusesByBuilding
Description

Gets the list of Campus objects mapped to a Building.

Parametersosid.id.IdbuildingId Id of a Building
Returnosid.room.CampusListlist of campuses
ErrorsNOT_FOUND buildingId is not found
NULL_ARGUMENT buildingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.