OSID Logo
OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.RoomProfile
Implementsosid.OsidProfile
Description

The room profile describes the interoperability among room services.

MethodsupportsVisibleFederation
Description

Tests if any building federation is exposed. Federation is exposed when a specific building may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of buildinges appears as a single building.

Returnboolean true if visible federation is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRoomLookup
Description

Tests for the availability of a room lookup service.

Returnboolean true if room lookup is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRoomQuery
Description

Tests if querying rooms is available.

Returnboolean true if room query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRoomSearch
Description

Tests if searching for rooms is available.

Returnboolean true if room search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRoomAdmin
Description

Tests if searching for rooms is available.

Returnboolean true if room search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRoomNotification
Description

Tests if room notification is available.

Returnboolean true if room notification is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRoomCampus
Description

Tests if a room to campus lookup session is available.

Returnboolean true if room campus lookup session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRoomCampusAssignment
Description

Tests if a room to campus assignment session is available.

Returnboolean true if room campus assignment is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRoomSmartCampus
Description

Tests if a room smart campus session is available.

Returnboolean true if room smart campus is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFloorLookup
Description

Tests for the availability of an floor lookup service.

Returnboolean true if floor lookup is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFloorQuery
Description

Tests if querying floores is available.

Returnboolean true if floor query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFloorSearch
Description

Tests if searching for floores is available.

Returnboolean true if floor search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFloorAdmin
Description

Tests for the availability of a floor administrative service for creating and deleting floores.

Returnboolean true if floor administration is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFloorNotification
Description

Tests for the availability of a floor notification service.

Returnboolean true if floor notification is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsFloorCampus
Description

Tests if a floor to campus lookup session is available.

Returnboolean true if floor campus lookup session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFloorCampusAssignment
Description

Tests if a floor to campus assignment session is available.

Returnboolean true if floor campus assignment is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFloorSmartCampus
Description

Tests if a floor smart campus session is available.

Returnboolean true if floor smart campus is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBuildingLookup
Description

Tests for the availability of an building lookup service.

Returnboolean true if building lookup is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBuildingQuery
Description

Tests if querying buildinges is available.

Returnboolean true if building query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBuildingSearch
Description

Tests if searching for buildinges is available.

Returnboolean true if building search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBuildingAdmin
Description

Tests for the availability of a building administrative service for creating and deleting buildinges.

Returnboolean true if building administration is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBuildingNotification
Description

Tests for the availability of a building notification service.

Returnboolean true if building notification is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsBuildingCampus
Description

Tests if a building to campus lookup session is available.

Returnboolean true if building campus lookup session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBuildingCampusAssignment
Description

Tests if a building to campus assignment session is available.

Returnboolean true if building campus assignment is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBuildingSmartCampus
Description

Tests if a building smart campus session is available.

Returnboolean true if building smart campus is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCampusLookup
Description

Tests for the availability of an campus lookup service.

Returnboolean true if campus lookup is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCampusQuery
Description

Tests if querying campuses is available.

Returnboolean true if campus query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCampusSearch
Description

Tests if searching for campuses is available.

Returnboolean true if campus search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCampusAdmin
Description

Tests for the availability of a campus administrative service for creating and deleting campuses.

Returnboolean true if campus administration is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCampusNotification
Description

Tests for the availability of a campus notification service.

Returnboolean true if campus notification is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsCampusHierarchy
Description

Tests for the availability of a campus hierarchy traversal service.

Returnboolean true if campus hierarchy traversal is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCampusHierarchyDesign
Description

Tests for the availability of a campus hierarchy design service.

Returnboolean true if campus hierarchy design is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsRoomBatch
Description

Tests for the availability of a room batch service.

Returnboolean true if a room batch service is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsRoomConstruction
Description

Tests for the availability of a room construction service.

Returnboolean true if a room construction service is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsRoomSquatting
Description

Tests for the availability of a room squatting service.

Returnboolean true if a room squatting service is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodgetRoomRecordTypes
Description

Gets the supported Room record types.

Returnosid.type.TypeLista list containing the supported room record types
CompliancemandatoryThis method must be implemented.
MethodsupportsRoomRecordType
Description

Tests if the given Room record type is supported.

Parametersosid.type.TyperoomRecordTypea Type indicating a Room record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT roomRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetRoomSearchRecordTypes
Description

Gets the supported room search record types.

Returnosid.type.TypeLista list containing the supported room search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsRoomSearchRecordType
Description

Tests if the given room search record type is supported.

Parametersosid.type.TyperoomSearchRecordTypea Type indicating a room record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT roomSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetFloorRecordTypes
Description

Gets the supported Floor record types.

Returnosid.type.TypeLista list containing the supported floor record types
CompliancemandatoryThis method must be implemented.
MethodsupportsFloorRecordType
Description

Tests if the given Floor record type is supported.

Parametersosid.type.TypefloorRecordTypea Type indicating a Floor record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT floorRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetFloorSearchRecordTypes
Description

Gets the supported floor search record types.

Returnosid.type.TypeLista list containing the supported floor search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsFloorSearchRecordType
Description

Tests if the given floor search record type is supported.

Parametersosid.type.TypefloorSearchRecordTypea Type indicating a floor record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT floorSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetBuildingRecordTypes
Description

Gets the supported Building record types.

Returnosid.type.TypeLista list containing the supported building record types
CompliancemandatoryThis method must be implemented.
MethodsupportsBuildingRecordType
Description

Tests if the given Building record type is supported.

Parametersosid.type.TypebuildingRecordTypea Type indicating a Building record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT buildingRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetBuildingSearchRecordTypes
Description

Gets the supported building search record types.

Returnosid.type.TypeLista list containing the supported building search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsBuildingSearchRecordType
Description

Tests if the given building search record type is supported.

Parametersosid.type.TypebuildingSearchRecordTypea Type indicating a building record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT buildingSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetCampusRecordTypes
Description

Gets the supported Campus record types.

Returnosid.type.TypeLista list containing the supported campus record types
CompliancemandatoryThis method must be implemented.
MethodsupportsCampusRecordType
Description

Tests if the given Campus record type is supported.

Parametersosid.type.TypecampusRecordTypea Type indicating a Campus record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT campusRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetCampusSearchRecordTypes
Description

Gets the supported campus search record types.

Returnosid.type.TypeLista list containing the supported campus search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsCampusSearchRecordType
Description

Tests if the given campus search record type is supported.

Parametersosid.type.TypecampusSearchRecordTypea Type indicating a campus record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT campusSearchRecordType is null
CompliancemandatoryThis method must be implemented.