OSID Logo
OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.RoomProxyManager
Implementsosid.OsidProxyManager
osid.room.RoomProfile
Description

The room manager provides access to room sessions and provides interoperability tests for various aspects of this service. Methods in this manager accept a Proxy for passing information from a server environment. 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.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.RoomLookupSessiona RoomLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRoomLookup() is false
ComplianceoptionalThis 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.IdcampusIdthe Id of the Campus
osid.proxy.Proxyproxya proxy
Returnosid.room.RoomLookupSessiona RoomLookupSession
ErrorsNOT_FOUNDno Campus found by the given Id
NULL_ARGUMENT campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRoomLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRoomLookup() and supportsVisibleFederation() are true
MethodgetRoomQuerySession
Description

Gets the OsidSession associated with the room query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.RoomQuerySessiona RoomQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRoomQuery() is false
ComplianceoptionalThis 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.IdcampusIdthe Id of the Campus
osid.proxy.Proxyproxya proxy
Returnosid.room.RoomQuerySessiona RoomQuerySession
ErrorsNOT_FOUNDno Campus found by the given Id
NULL_ARGUMENT campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRoomQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRoomQuery() and supportsVisibleFederation() are true
MethodgetRoomSearchSession
Description

Gets the OsidSession associated with the room search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.RoomSearchSessiona RoomSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRoomSearch() is false
ComplianceoptionalThis 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.IdcampusIdthe Id of the Campus
osid.proxy.Proxyproxya proxy
Returnosid.room.RoomSearchSessiona RoomSearchSession
ErrorsNOT_FOUNDno Campus found by the given Id
NULL_ARGUMENT campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRoomSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRoomSearch() and supportsVisibleFederation() are true
MethodgetRoomAdminSession
Description

Gets the OsidSession associated with the room administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.RoomAdminSessiona RoomAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRoomAdmin() is false
ComplianceoptionalThis 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.IdcampusIdthe Id of the Campus
osid.proxy.Proxyproxya proxy
Returnosid.room.RoomAdminSessiona RoomAdminSession
ErrorsNOT_FOUNDno Campus found by the given Id
NULL_ARGUMENT campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRoomAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRoomAdmin() and supportsVisibleFederation() are true
MethodgetRoomNotificationSession
Description

Gets the OsidSession associated with the room notification service.

Parametersosid.room.RoomReceiverroomReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.room.RoomNotificationSessiona RoomNotificationSession
ErrorsNULL_ARGUMENT roomReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRoomNotification() is false
ComplianceoptionalThis 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.RoomReceiverroomReceiverthe receiver
osid.id.IdcampusIdthe Id of the Campus
osid.proxy.Proxyproxya proxy
Returnosid.room.RoomNotificationSessiona RoomNotificationSession
ErrorsNOT_FOUNDno Campus found by the given Id
NULL_ARGUMENT roomReceiver, campusId, or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRoomNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRoomNotification() and supportsVisibleFederation() are true
MethodgetRoomCampusSession
Description

Gets the session for retrieving room to campus mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.RoomCampusSessiona RoomCampusSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRoomCampus() is false
ComplianceoptionalThis method must be implemented if supportsRoomCampus() is true.
MethodgetRoomCampusAssignmentSession
Description

Gets the session for assigning room to campus mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.RoomCampusAssignmentSessiona RoomCampusAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRoomCampusAssignment() is false
ComplianceoptionalThis 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.IdcampusIdthe Id of the campus
osid.proxy.Proxyproxya proxy
Returnosid.room.RoomSmartCampusSessiona RoomSmartCampusSession
ErrorsNOT_FOUND campusId not found
NULL_ARGUMENT campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRoomSmartCampus() is false
ComplianceoptionalThis method must be implemented if supportsRoomSmartCampus() is true.
MethodgetFloorLookupSession
Description

Gets the OsidSession associated with the floor lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.FloorLookupSessiona FloorLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFloorLookup() is false
ComplianceoptionalThis 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.IdcampusIdthe Id of the Campus
osid.proxy.Proxyproxya proxy
Returnosid.room.FloorLookupSessiona FloorLookupSession
ErrorsNOT_FOUNDno Campus found by the given Id
NULL_ARGUMENT campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFloorLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsFloorLookup() and supportsVisibleFederation() are true
MethodgetFloorQuerySession
Description

Gets the OsidSession associated with the floor query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.FloorQuerySessiona FloorQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFloorQuery() is false
ComplianceoptionalThis 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.IdcampusIdthe Id of the Campus
osid.proxy.Proxyproxya proxy
Returnosid.room.FloorQuerySessiona FloorQuerySession
ErrorsNOT_FOUNDno Floor found by the given Id
NULL_ARGUMENT campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFloorQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsFloorQuery() and supportsVisibleFederation() are true
MethodgetFloorSearchSession
Description

Gets the OsidSession associated with the floor search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.FloorSearchSessiona FloorSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFloorSearch() is false
ComplianceoptionalThis 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.IdcampusIdthe Id of the Campus
osid.proxy.Proxyproxya proxy
Returnosid.room.FloorSearchSessiona FloorSearchSession
ErrorsNOT_FOUNDno Floor found by the given Id
NULL_ARGUMENT campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFloorSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsFloorSearch() and supportsVisibleFederation() are true
MethodgetFloorAdminSession
Description

Gets the OsidSession associated with the floor administrative service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.FloorAdminSessiona FloorAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFloorAdmin() is false
ComplianceoptionalThis method must be implemented if supportsFloorAdmin() is true.
MethodgetFloorAdminSessionForCampus
Description

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

Parametersosid.id.IdcampusIdthe Id of the Campus
osid.proxy.Proxyproxya proxy
Returnosid.room.FloorAdminSessiona FloorAdminSession
ErrorsNOT_FOUNDno Floor found by the given Id
NULL_ARGUMENT campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFloorAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsFloorAdmin() and supportsVisibleFederation() are true
MethodgetFloorNotificationSession
Description

Gets the OsidSession associated with the floor notification service.

Parametersosid.room.FloorReceiverfloorReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.room.FloorNotificationSessiona FloorNotificationSession
ErrorsNULL_ARGUMENT floorReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFloorNotification() is false
ComplianceoptionalThis 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.FloorReceiverfloorReceiverthe receiver
osid.id.IdcampusIdthe Id of the Campus
osid.proxy.Proxyproxya proxy
Returnosid.room.FloorNotificationSessiona FloorNotificationSession
ErrorsNOT_FOUNDno Floor found by the given Id
NULL_ARGUMENT floorReceiver, campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFloorNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsFloorNotification() and supportsVisibleFederation() are true
MethodgetFloorCampusSession
Description

Gets the session for retrieving floor to campus mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.FloorCampusSessiona FloorCampusSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFloorCampus() is false
ComplianceoptionalThis method must be implemented if supportsFloorCampus() is true.
MethodgetFloorCampusAssignmentSession
Description

Gets the session for assigning floor to campus mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.FloorCampusAssignmentSessiona FloorCampusAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFloorCampusAssignment() is false
ComplianceoptionalThis method must be implemented if supportsFloorCampusAssignment() is true.
MethodgetFloorSmartCampusSession
Description

Gets the session for managing dynamic floor campuses for the given campus.

Parametersosid.id.IdcampusIdthe Id of a campus
osid.proxy.Proxyproxya proxy
Returnosid.room.FloorSmartCampusSessiona FloorSmartCampusSession
ErrorsNOT_FOUND campusId not found
NULL_ARGUMENT campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFloorSmartCampus() is false
ComplianceoptionalThis method must be implemented if supportsFloorSmartCampus() is true.
MethodgetBuildingLookupSession
Description

Gets the OsidSession associated with the building lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.BuildingLookupSessiona BuildingLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBuildingLookup() is false
ComplianceoptionalThis 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.IdcampusIdthe Id of the Campus
osid.proxy.Proxyproxya proxy
Returnosid.room.BuildingLookupSessiona BuildingLookupSession
ErrorsNOT_FOUNDno Campus found by the given Id
NULL_ARGUMENT campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBuildingLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBuildingLookup() and supportsVisibleFederation() are true
MethodgetBuildingQuerySession
Description

Gets the OsidSession associated with the building query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.BuildingQuerySessiona BuildingQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBuildingQuery() is false
ComplianceoptionalThis 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.IdcampusIdthe Id of the Campus
osid.proxy.Proxyproxya proxy
Returnosid.room.BuildingQuerySessiona BuildingQuerySession
ErrorsNOT_FOUNDno Building found by the given Id
NULL_ARGUMENT campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBuildingQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBuildingQuery() and supportsVisibleFederation() are true
MethodgetBuildingSearchSession
Description

Gets the OsidSession associated with the building search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.BuildingSearchSessiona BuildingSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBuildingSearch() is false
ComplianceoptionalThis 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.IdcampusIdthe Id of the Campus
osid.proxy.Proxyproxya proxy
Returnosid.room.BuildingSearchSessiona BuildingSearchSession
ErrorsNOT_FOUNDno Building found by the given Id
NULL_ARGUMENT campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBuildingSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBuildingSearch() and supportsVisibleFederation() are true
MethodgetBuildingAdminSession
Description

Gets the OsidSession associated with the building administrative service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.BuildingAdminSessiona BuildingAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBuildingAdmin() is false
ComplianceoptionalThis method must be implemented if supportsBuildingAdmin() is true.
MethodgetBuildingAdminSessionForCampus
Description

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

Parametersosid.id.IdcampusIdthe Id of the Campus
osid.proxy.Proxyproxya proxy
Returnosid.room.BuildingAdminSessiona BuildingAdminSession
ErrorsNOT_FOUNDno Building found by the given Id
NULL_ARGUMENT campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBuildingAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBuildingAdmin() and supportsVisibleFederation() are true
MethodgetBuildingNotificationSession
Description

Gets the OsidSession associated with the building notification service.

Parametersosid.room.BuildingReceiverbuildingReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.room.BuildingNotificationSessiona BuildingNotificationSession
ErrorsNULL_ARGUMENT buildingReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBuildingNotification() is false
ComplianceoptionalThis 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.BuildingReceiverbuildingReceiverthe receiver
osid.id.IdcampusIdthe Id of the Campus
osid.proxy.Proxyproxya proxy
Returnosid.room.BuildingNotificationSessiona BuildingNotificationSession
ErrorsNOT_FOUNDno Building found by the given Id
NULL_ARGUMENT buildingReceiver, campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBuildingNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBuildingNotification() and supportsVisibleFederation() are true
MethodgetBuildingCampusSession
Description

Gets the session for retrieving building to campus mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.BuildingCampusSessiona BuildingCampusSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBuildingCampus() is false
ComplianceoptionalThis method must be implemented if supportsBuildingCampus() is true.
MethodgetBuildingCampusAssignmentSession
Description

Gets the session for assigning building to campus mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.BuildingCampusAssignmentSessiona BuildingCampusAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBuildingCampusAssignment() is false
ComplianceoptionalThis method must be implemented if supportsBuildingCampusAssignment() is true.
MethodgetBuildingSmartCampusSession
Description

Gets the session for managing dynamic building campuses for the given campus.

Parametersosid.id.IdcampusIdthe Id of a campus
osid.proxy.Proxyproxya proxy
Returnosid.room.BuildingSmartCampusSessiona BuildingSmartCampusSession
ErrorsNOT_FOUND campusId not found
NULL_ARGUMENT campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBuildingSmartCampus() is false
ComplianceoptionalThis method must be implemented if supportsBuildingSmartCampus() is true.
MethodgetCampusLookupSession
Description

Gets the OsidSession associated with the campus lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.CampusLookupSessiona CampusLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCampusLookup() is false
ComplianceoptionalThis method must be implemented if supportsCampusLookup() is true.
MethodgetCampusQuerySession
Description

Gets the OsidSession associated with the campus query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.CampusQuerySessiona CampusQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCampusQuery() is false
ComplianceoptionalThis method must be implemented if supportsCampusQuery() is true.
MethodgetCampusSearchSession
Description

Gets the OsidSession associated with the campus search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.CampusSearchSessiona CampusSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCampusSearch() is false
ComplianceoptionalThis method must be implemented if supportsCampusSearch() is true.
MethodgetCampusAdminSession
Description

Gets the OsidSession associated with the campus administrative service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.CampusAdminSessiona CampusAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCampusAdmin() is false
ComplianceoptionalThis method must be implemented if supportsCampusAdmin() is true.
MethodgetCampusNotificationSession
Description

Gets the OsidSession associated with the campus notification service.

Parametersosid.room.CampusReceivercampusReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.room.CampusNotificationSessiona CampusNotificationSession
ErrorsNULL_ARGUMENT campusReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCampusNotification() is false
ComplianceoptionalThis method must be implemented if supportsCampusNotification() is true.
MethodgetCampusHierarchySession
Description

Gets the OsidSession associated with the campus hierarchy service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.CampusHierarchySessiona CampusHierarchySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCampusHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsCampusHierarchy() is true.
MethodgetCampusHierarchyDesignSession
Description

Gets the OsidSession associated with the campus hierarchy design service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.CampusHierarchyDesignSessiona CampusHierarchyDesignSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCampusHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsCampusHierarchyDesign() is true.
MethodgetRoomBatchProxyManager
Description

Gets the RoomBatchProxyManager.

Returnosid.room.batch.RoomBatchProxyManagera RoomBatchProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRoomRules() is false
ComplianceoptionalThis method must be implemented if supportsRoomRules() is true.
MethodgetRoomConstructionProxyManager
Description

Gets the RoomConstructionProxyManager.

Returnosid.room.construction.RoomConstructionProxyManagera RoomConstructionProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRoomConstruction() is false
ComplianceoptionalThis method must be implemented if supportsRoomConstruction() is true.
MethodgetRoomSquattingProxyManager
Description

Gets the RoomSquattingProxyManager.

Returnosid.room.squatting.RoomSquattingProxyManagera RoomSquattingProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRoomSquatting() is false
ComplianceoptionalThis method must be implemented if supportsRoomSquatting() is true.