OSID Logo
OSID Specifications
room package
Version 3.1.0
Interfaceosid.room.RoomManager
Implementsosid.OsidManager
osid.room.RoomProfile
Description

The room manager provides access to room sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • RoomLookupSession: a session to lookup rooms
  • RoomQuerySession: a session to query rooms
  • RoomSearchSession: a session to search rooms
  • RoomAdminSession: a session to manage rooms
  • RoomNotificationSession: a session to subscribe to notifications of room changes
  • RoomCampusSession: a session to look up room campus mappings
  • RoomCampusAssignmentSession: a session to manage room campus mappings
  • RoomSmartCampusSession: a session to manage smart campuses of rooms
  • FloorLookupSession: a session to retrieve floores
  • FloorQuerySession: a session to query floores
  • FloorSearchSession: a session to search for floores
  • FloorAdminSession: a session to create, update and delete floores
  • FloorNotificationSession: a session to receive notifications for changes in floores
  • FloorCampusSession: a session to look up floor campus mappings
  • FloorCampusAssignmentSession: a session to manage floor campus mappings
  • FloorSmartCampusSession: a session to manage smart campuses of floores
  • BuildingLookupSession: a session to retrieve buildinges
  • BuildingQuerySession: a session to query buildinges
  • BuildingSearchSession: a session to search for buildinges
  • BuildingAdminSession: a session to create, update and delete buildinges
  • BuildingNotificationSession: a session to receive notifications for changes in buildinges
  • BuildingCampusSession: a session to look up building campus mappings
  • BuildingCampusAssignmentSession: a session to manage building campus mappings
  • BuildingSmartCampusSession: a session to manage smart campuses of buildinges
  • CampusLookupSession: a session to retrieve campuss
  • CampusQuerySession: a session to query campuss
  • CampusSearchSession: a session to search for campuss
  • CampusAdminSession: a session to create, update and delete campuss
  • CampusNotificationSession: a session to receive notifications for changes in campuss
  • CampusHierarchySession: a session to traverse hierarchies of campuss
  • CampusHierarchyDesignSession: a session to manage hierarchies of campuses

The room manager also provides a profile for determing the supported search types supported by this service.

MethodgetRoomLookupSession
Description

Gets the OsidSession associated with the room lookup service.

Returnosid.room.RoomLookupSession a RoomLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRoomLookup() is false
Complianceoptional This method must be implemented if supportsRoomLookup() is true.
MethodgetRoomLookupSessionForCampus
Description

Gets the OsidSession associated with the room lookup service for the given campus.

Parametersosid.id.IdcampusId the Id of the Campus
Returnosid.room.RoomLookupSession a RoomLookupSession
ErrorsNOT_FOUND no Campus found by the given Id
NULL_ARGUMENT campusId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRoomLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsRoomLookup() and supportsVisibleFederation() are true
MethodgetRoomQuerySession
Description

Gets the OsidSession associated with the room query service.

Returnosid.room.RoomQuerySession a RoomQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRoomQuery() is false
Complianceoptional This method must be implemented if supportsRoomQuery() is true.
MethodgetRoomQuerySessionForCampus
Description

Gets the OsidSession associated with the room query service for the given campus.

Parametersosid.id.IdcampusId the Id of the Campus
Returnosid.room.RoomQuerySession a RoomQuerySession
ErrorsNOT_FOUND no Campus found by the given Id
NULL_ARGUMENT campusId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRoomQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsRoomQuery() and supportsVisibleFederation() are true
MethodgetRoomSearchSession
Description

Gets the OsidSession associated with the room search service.

Returnosid.room.RoomSearchSession a RoomSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRoomSearch() is false
Complianceoptional This method must be implemented if supportsRoomSearch() is true.
MethodgetRoomSearchSessionForCampus
Description

Gets the OsidSession associated with the room search service for the given campus.

Parametersosid.id.IdcampusId the Id of the Campus
Returnosid.room.RoomSearchSession a RoomSearchSession
ErrorsNOT_FOUND no Campus found by the given Id
NULL_ARGUMENT campusId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRoomSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsRoomSearch() and supportsVisibleFederation() are true
MethodgetRoomAdminSession
Description

Gets the OsidSession associated with the room administration service.

Returnosid.room.RoomAdminSession a RoomAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRoomAdmin() is false
Complianceoptional This method must be implemented if supportsRoomAdmin() is true.
MethodgetRoomAdminSessionForCampus
Description

Gets the OsidSession associated with the room administration service for the given campus.

Parametersosid.id.IdcampusId the Id of the Campus
Returnosid.room.RoomAdminSession a RoomAdminSession
ErrorsNOT_FOUND no Campus found by the given Id
NULL_ARGUMENT campusId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRoomAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsRoomAdmin() and supportsVisibleFederation() are true
MethodgetRoomNotificationSession
Description

Gets the OsidSession associated with the room notification service.

Parametersosid.room.RoomReceiverroomReceiver the receiver
Returnosid.room.RoomNotificationSession a RoomNotificationSession
ErrorsNULL_ARGUMENT roomReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRoomNotification() is false
Complianceoptional This method must be implemented if supportsRoomNotification() is true.
MethodgetRoomNotificationSessionForCampus
Description

Gets the OsidSession associated with the room notification service for the given campus.

Parametersosid.room.RoomReceiverroomReceiver the receiver
osid.id.IdcampusId the Id of the Campus
Returnosid.room.RoomNotificationSession a RoomNotificationSession
ErrorsNOT_FOUND no Campus found by the given Id
NULL_ARGUMENT roomReceiver or campusId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRoomNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsRoomNotification() and supportsVisibleFederation() are true
MethodgetRoomCampusSession
Description

Gets the session for retrieving room to campus mappings.

Returnosid.room.RoomCampusSession a RoomCampusSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRoomCampus() is false
Complianceoptional This method must be implemented if supportsRoomCampus() is true.
MethodgetRoomCampusAssignmentSession
Description

Gets the session for assigning room to campus mappings.

Returnosid.room.RoomCampusAssignmentSession a RoomCampusAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRoomCampusAssignment() is false
Complianceoptional This method must be implemented if supportsRoomCampusAssignment() is true.
MethodgetRoomSmartCampusSession
Description

Gets the session associated with the room smart campus for the given campus.

Parametersosid.id.IdcampusId the Id of the campus
Returnosid.room.RoomSmartCampusSession a RoomSmartCampusSession
ErrorsNOT_FOUND campusId not found
NULL_ARGUMENT campusId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRoomSmartCampus() is false
Complianceoptional This method must be implemented if supportsRoomSmartCampus() is true.
MethodgetFloorLookupSession
Description

Gets the OsidSession associated with the floor lookup service.

Returnosid.room.FloorLookupSession a FloorLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFloorLookup() is false
Complianceoptional This method must be implemented if supportsFloorLookup() is true.
MethodgetFloorLookupSessionForCampus
Description

Gets the OsidSession associated with the floor lookup service for the given campus.

Parametersosid.id.IdcampusId the Id of the Floor
Returnosid.room.FloorLookupSession a FloorLookupSession
ErrorsNOT_FOUND no Campus found by the given Id
NULL_ARGUMENT campusId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFloorLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsFloorLookup() and supportsVisibleFederation() are true
MethodgetFloorQuerySession
Description

Gets the OsidSession associated with the floor query service.

Returnosid.room.FloorQuerySession a FloorQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFloorQuery() is false
Complianceoptional This method must be implemented if supportsFloorQuery() is true.
MethodgetFloorQuerySessionForCampus
Description

Gets the OsidSession associated with the floor query service for the given campus.

Parametersosid.id.IdcampusId the Id of the Floor
Returnosid.room.FloorQuerySession a FloorQuerySession
ErrorsNOT_FOUND no Campus found by the given Id
NULL_ARGUMENT campusId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFloorQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsFloorQuery() and supportsVisibleFederation() are true
MethodgetFloorSearchSession
Description

Gets the OsidSession associated with the floor search service.

Returnosid.room.FloorSearchSession a FloorSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFloorSearch() is false
Complianceoptional This method must be implemented if supportsFloorSearch() is true.
MethodgetFloorSearchSessionForCampus
Description

Gets the OsidSession associated with the floor search service for the given campus.

Parametersosid.id.IdcampusId the Id of the Floor
Returnosid.room.FloorSearchSession a FloorSearchSession
ErrorsNOT_FOUND no Campus found by the given Id
NULL_ARGUMENT campusId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFloorSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsFloorSearch() and supportsVisibleFederation() are true
MethodgetFloorAdminSession
Description

Gets the OsidSession associated with the floor administrative service.

Returnosid.room.FloorAdminSession a FloorAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFloorAdmin() is false
Complianceoptional This method must be implemented if supportsFloorAdmin() is true.
MethodgetFloorAdminSessionForCampus
Description

Gets the OsidSession associated with the floor administrative service for the given campus.

Parametersosid.id.IdcampusId the Id of the Floor
Returnosid.room.FloorAdminSession a FloorAdminSession
ErrorsNOT_FOUND no Campus found by the given Id
NULL_ARGUMENT campusId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFloorAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsFloorAdmin() and supportsVisibleFederation() are true
MethodgetFloorNotificationSession
Description

Gets the OsidSession associated with the floor notification service.

Parametersosid.room.FloorReceiverfloorReceiver the receiver
Returnosid.room.FloorNotificationSession a FloorNotificationSession
ErrorsNULL_ARGUMENT floorReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFloorNotification() is false
Complianceoptional This method must be implemented if supportsFloorNotification() is true.
MethodgetFloorNotificationSessionForCampus
Description

Gets the OsidSession associated with the floor notification service for the given campus.

Parametersosid.room.FloorReceiverfloorReceiver the receiver
osid.id.IdcampusId the Id of the Campus
Returnosid.room.FloorNotificationSession a FloorNotificationSession
ErrorsNOT_FOUND no Campus found by the given Id
NULL_ARGUMENT floorReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFloorNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsFloorNotification() and supportsVisibleFederation() are true
MethodgetFloorCampusSession
Description

Gets the session for retrieving floor to campus mappings.

Returnosid.room.FloorCampusSession a FloorCampusSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFloorCampus() is false
Complianceoptional This method must be implemented if supportsFloorCampus() is true.
MethodgetFloorCampusAssignmentSession
Description

Gets the session for assigning floor to campus mappings.

Returnosid.room.FloorCampusAssignmentSession a FloorCampusAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFloorCampusAssignment() is false
Complianceoptional This method must be implemented if supportsFloorCampusAssignment() is true.
MethodgetFloorSmartCampusSession
Description

Gets the session associated with the floor smart campus for the given campus.

Parametersosid.id.IdcampusId the Id of the campus
Returnosid.room.FloorSmartCampusSession a FloorSmartCampusSession
ErrorsNOT_FOUND campusId not found
NULL_ARGUMENT campusId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFloorSmartCampus() is false
Complianceoptional This method must be implemented if supportsFloorSmartCampus() is true.
MethodgetBuildingLookupSession
Description

Gets the OsidSession associated with the building lookup service.

Returnosid.room.BuildingLookupSession a BuildingLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBuildingLookup() is false
Complianceoptional This method must be implemented if supportsBuildingLookup() is true.
MethodgetBuildingLookupSessionForCampus
Description

Gets the OsidSession associated with the building lookup service for the given campus.

Parametersosid.id.IdcampusId the Id of the Building
Returnosid.room.BuildingLookupSession a BuildingLookupSession
ErrorsNOT_FOUND no Campus found by the given Id
NULL_ARGUMENT campusId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBuildingLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsBuildingLookup() and supportsVisibleFederation() are true
MethodgetBuildingQuerySession
Description

Gets the OsidSession associated with the building query service.

Returnosid.room.BuildingQuerySession a BuildingQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBuildingQuery() is false
Complianceoptional This method must be implemented if supportsBuildingQuery() is true.
MethodgetBuildingQuerySessionForCampus
Description

Gets the OsidSession associated with the building query service for the given campus.

Parametersosid.id.IdcampusId the Id of the Building
Returnosid.room.BuildingQuerySession a BuildingQuerySession
ErrorsNOT_FOUND no Campus found by the given Id
NULL_ARGUMENT campusId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBuildingQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsBuildingQuery() and supportsVisibleFederation() are true
MethodgetBuildingSearchSession
Description

Gets the OsidSession associated with the building search service.

Returnosid.room.BuildingSearchSession a BuildingSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBuildingSearch() is false
Complianceoptional This method must be implemented if supportsBuildingSearch() is true.
MethodgetBuildingSearchSessionForCampus
Description

Gets the OsidSession associated with the building search service for the given campus.

Parametersosid.id.IdcampusId the Id of the Building
Returnosid.room.BuildingSearchSession a BuildingSearchSession
ErrorsNOT_FOUND no Campus found by the given Id
NULL_ARGUMENT campusId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBuildingSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsBuildingSearch() and supportsVisibleFederation() are true
MethodgetBuildingAdminSession
Description

Gets the OsidSession associated with the building administrative service.

Returnosid.room.BuildingAdminSession a BuildingAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBuildingAdmin() is false
Complianceoptional This method must be implemented if supportsBuildingAdmin() is true.
MethodgetBuildingAdminSessionForCampus
Description

Gets the OsidSession associated with the building administrative service for the given campus.

Parametersosid.id.IdcampusId the Id of the Building
Returnosid.room.BuildingAdminSession a BuildingAdminSession
ErrorsNOT_FOUND no Campus found by the given Id
NULL_ARGUMENT campusId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBuildingAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsBuildingAdmin() and supportsVisibleFederation() are true
MethodgetBuildingNotificationSession
Description

Gets the OsidSession associated with the building notification service.

Parametersosid.room.BuildingReceiverbuildingReceiver the receiver
Returnosid.room.BuildingNotificationSession a BuildingNotificationSession
ErrorsNULL_ARGUMENT buildingReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBuildingNotification() is false
Complianceoptional This method must be implemented if supportsBuildingNotification() is true.
MethodgetBuildingNotificationSessionForCampus
Description

Gets the OsidSession associated with the building notification service for the given campus.

Parametersosid.room.BuildingReceiverbuildingReceiver the receiver
osid.id.IdcampusId the Id of the Campus
Returnosid.room.BuildingNotificationSession a BuildingNotificationSession
ErrorsNOT_FOUND no Campus found by the given Id
NULL_ARGUMENT buildingReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBuildingNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsBuildingNotification() and supportsVisibleFederation() are true
MethodgetBuildingCampusSession
Description

Gets the session for retrieving building to campus mappings.

Returnosid.room.BuildingCampusSession a BuildingCampusSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBuildingCampus() is false
Complianceoptional This method must be implemented if supportsBuildingCampus() is true.
MethodgetBuildingCampusAssignmentSession
Description

Gets the session for assigning building to campus mappings.

Returnosid.room.BuildingCampusAssignmentSession a BuildingCampusAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBuildingCampusAssignment() is false
Complianceoptional This method must be implemented if supportsBuildingCampusAssignment() is true.
MethodgetBuildingSmartCampusSession
Description

Gets the session associated with the building smart campus for the given campus.

Parametersosid.id.IdcampusId the Id of the campus
Returnosid.room.BuildingSmartCampusSession a BuildingSmartCampusSession
ErrorsNOT_FOUND campusId not found
NULL_ARGUMENT campusId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBuildingSmartCampus() is false
Complianceoptional This method must be implemented if supportsBuildingSmartCampus() is true.
MethodgetCampusLookupSession
Description

Gets the OsidSession associated with the campus lookup service.

Returnosid.room.CampusLookupSession a CampusLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCampusLookup() is false
Complianceoptional This method must be implemented if supportsCampusLookup() is true.
MethodgetCampusQuerySession
Description

Gets the OsidSession associated with the campus query service.

Returnosid.room.CampusQuerySession a CampusQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCampusQuery() is false
Complianceoptional This method must be implemented if supportsCampusQuery() is true.
MethodgetCampusSearchSession
Description

Gets the OsidSession associated with the campus search service.

Returnosid.room.CampusSearchSession a CampusSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCampusSearch() is false
Complianceoptional This method must be implemented if supportsCampusSearch() is true.
MethodgetCampusAdminSession
Description

Gets the OsidSession associated with the campus administrative service.

Returnosid.room.CampusAdminSession a CampusAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCampusAdmin() is false
Complianceoptional This method must be implemented if supportsCampusAdmin() is true.
MethodgetCampusNotificationSession
Description

Gets the OsidSession associated with the campus notification service.

Parametersosid.room.CampusReceivercampusReceiver the receiver
Returnosid.room.CampusNotificationSession a CampusNotificationSession
ErrorsNULL_ARGUMENT campusReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCampusNotification() is false
Complianceoptional This method must be implemented if supportsCampusNotification() is true.
MethodgetCampusHierarchySession
Description

Gets the OsidSession associated with the campus hierarchy service.

Returnosid.room.CampusHierarchySession a CampusHierarchySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCampusHierarchy() is false
Complianceoptional This method must be implemented if supportsCampusHierarchy() is true.
MethodgetCampusHierarchyDesignSession
Description

Gets the OsidSession associated with the campus hierarchy design service.

Returnosid.room.CampusHierarchyDesignSession a CampusHierarchyDesignSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCampusHierarchyDesign() is false
Complianceoptional This method must be implemented if supportsCampusHierarchyDesign() is true.
MethodgetRoomBatchManager
Description

Gets the RoomBatchManager.

Returnosid.room.batch.RoomBatchManager a RoomBatchManager
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRoombatch() is false
Complianceoptional This method must be implemented if supportsRoombatch() is true.
MethodgetRoomConstructionManager
Description

Gets the RoomConstructionManager.

Returnosid.room.construction.RoomConstructionManager a RoomConstructionManager
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRoomConstruction() is false
Complianceoptional This method must be implemented if supportsRoomConstruction() is true.
MethodgetRoomSquattingManager
Description

Gets the RoomSquattingManager.

Returnosid.room.squatting.RoomSquattingManager a RoomSquattingManager
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRoomSquatting() is false
Complianceoptional This method must be implemented if supportsRoomSquatting() is true.