Interface | osid.room.RoomManager | ||
---|---|---|---|
Implements | osid.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:
The room manager also provides a profile for determing the supported search types supported by this service. | ||
Method | getRoomLookupSession | ||
Description |
Gets the | ||
Return | osid.room.RoomLookupSession | a RoomLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRoomLookup() is false | ||
Compliance | optional | This method must be implemented if supportsRoomLookup() is
true. | |
Method | getRoomLookupSessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.id.Id | campusId | the Id of the Campus |
Return | osid.room.RoomLookupSession | a RoomLookupSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsRoomLookup() and
supportsVisibleFederation() are true | |
Method | getRoomQuerySession | ||
Description |
Gets the | ||
Return | osid.room.RoomQuerySession | a RoomQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRoomQuery() is false | ||
Compliance | optional | This method must be implemented if supportsRoomQuery() is
true. | |
Method | getRoomQuerySessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.id.Id | campusId | the Id of the Campus |
Return | osid.room.RoomQuerySession | a RoomQuerySession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsRoomQuery() and
supportsVisibleFederation() are true | |
Method | getRoomSearchSession | ||
Description |
Gets the | ||
Return | osid.room.RoomSearchSession | a RoomSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRoomSearch() is false | ||
Compliance | optional | This method must be implemented if supportsRoomSearch() is
true. | |
Method | getRoomSearchSessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.id.Id | campusId | the Id of the Campus |
Return | osid.room.RoomSearchSession | a RoomSearchSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsRoomSearch() and
supportsVisibleFederation() are true | |
Method | getRoomAdminSession | ||
Description |
Gets the | ||
Return | osid.room.RoomAdminSession | a RoomAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRoomAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsRoomAdmin() is
true. | |
Method | getRoomAdminSessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.id.Id | campusId | the Id of the Campus |
Return | osid.room.RoomAdminSession | a RoomAdminSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsRoomAdmin() and
supportsVisibleFederation() are true | |
Method | getRoomNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.room.RoomReceiver | roomReceiver | the receiver |
Return | osid.room.RoomNotificationSession | a RoomNotificationSession | |
Errors | NULL_ARGUMENT | roomReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRoomNotification() is false | ||
Compliance | optional | This method must be implemented if supportsRoomNotification()
is true. | |
Method | getRoomNotificationSessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.room.RoomReceiver | roomReceiver | the receiver |
osid.id.Id | campusId | the Id of the Campus | |
Return | osid.room.RoomNotificationSession | a RoomNotificationSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsRoomNotification()
and supportsVisibleFederation() are true | |
Method | getRoomCampusSession | ||
Description |
Gets the session for retrieving room to campus mappings. | ||
Return | osid.room.RoomCampusSession | a RoomCampusSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRoomCampus() is false | ||
Compliance | optional | This method must be implemented if supportsRoomCampus() is
true. | |
Method | getRoomCampusAssignmentSession | ||
Description |
Gets the session for assigning room to campus mappings. | ||
Return | osid.room.RoomCampusAssignmentSession | a RoomCampusAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRoomCampusAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsRoomCampusAssignment()
is true. | |
Method | getRoomSmartCampusSession | ||
Description |
Gets the session associated with the room smart campus for the given campus. | ||
Parameters | osid.id.Id | campusId | the Id of the campus |
Return | osid.room.RoomSmartCampusSession | a RoomSmartCampusSession | |
Errors | NOT_FOUND | campusId not found | |
NULL_ARGUMENT | campusId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRoomSmartCampus() is false | ||
Compliance | optional | This method must be implemented if supportsRoomSmartCampus()
is true. | |
Method | getFloorLookupSession | ||
Description |
Gets the | ||
Return | osid.room.FloorLookupSession | a FloorLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsFloorLookup() is false | ||
Compliance | optional | This method must be implemented if supportsFloorLookup() is
true. | |
Method | getFloorLookupSessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.id.Id | campusId | the Id of the Floor |
Return | osid.room.FloorLookupSession | a FloorLookupSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsFloorLookup() and
supportsVisibleFederation() are true | |
Method | getFloorQuerySession | ||
Description |
Gets the | ||
Return | osid.room.FloorQuerySession | a FloorQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsFloorQuery() is false | ||
Compliance | optional | This method must be implemented if supportsFloorQuery() is
true. | |
Method | getFloorQuerySessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.id.Id | campusId | the Id of the Floor |
Return | osid.room.FloorQuerySession | a FloorQuerySession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsFloorQuery() and
supportsVisibleFederation() are true | |
Method | getFloorSearchSession | ||
Description |
Gets the | ||
Return | osid.room.FloorSearchSession | a FloorSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsFloorSearch() is false | ||
Compliance | optional | This method must be implemented if supportsFloorSearch() is
true. | |
Method | getFloorSearchSessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.id.Id | campusId | the Id of the Floor |
Return | osid.room.FloorSearchSession | a FloorSearchSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsFloorSearch() and
supportsVisibleFederation() are true | |
Method | getFloorAdminSession | ||
Description |
Gets the | ||
Return | osid.room.FloorAdminSession | a FloorAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsFloorAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsFloorAdmin() is
true. | |
Method | getFloorAdminSessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.id.Id | campusId | the Id of the Floor |
Return | osid.room.FloorAdminSession | a FloorAdminSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsFloorAdmin() and
supportsVisibleFederation() are true | |
Method | getFloorNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.room.FloorReceiver | floorReceiver | the receiver |
Return | osid.room.FloorNotificationSession | a FloorNotificationSession | |
Errors | NULL_ARGUMENT | floorReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsFloorNotification() is false | ||
Compliance | optional | This method must be implemented if supportsFloorNotification()
is true. | |
Method | getFloorNotificationSessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.room.FloorReceiver | floorReceiver | the receiver |
osid.id.Id | campusId | the Id of the Campus | |
Return | osid.room.FloorNotificationSession | a FloorNotificationSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsFloorNotification()
and supportsVisibleFederation() are true | |
Method | getFloorCampusSession | ||
Description |
Gets the session for retrieving floor to campus mappings. | ||
Return | osid.room.FloorCampusSession | a FloorCampusSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsFloorCampus() is false | ||
Compliance | optional | This method must be implemented if supportsFloorCampus() is
true. | |
Method | getFloorCampusAssignmentSession | ||
Description |
Gets the session for assigning floor to campus mappings. | ||
Return | osid.room.FloorCampusAssignmentSession | a FloorCampusAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsFloorCampusAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsFloorCampusAssignment()
is true. | |
Method | getFloorSmartCampusSession | ||
Description |
Gets the session associated with the floor smart campus for the given campus. | ||
Parameters | osid.id.Id | campusId | the Id of the campus |
Return | osid.room.FloorSmartCampusSession | a FloorSmartCampusSession | |
Errors | NOT_FOUND | campusId not found | |
NULL_ARGUMENT | campusId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsFloorSmartCampus() is false | ||
Compliance | optional | This method must be implemented if supportsFloorSmartCampus()
is true. | |
Method | getBuildingLookupSession | ||
Description |
Gets the | ||
Return | osid.room.BuildingLookupSession | a BuildingLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBuildingLookup() is false | ||
Compliance | optional | This method must be implemented if supportsBuildingLookup()
is true. | |
Method | getBuildingLookupSessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.id.Id | campusId | the Id of the Building |
Return | osid.room.BuildingLookupSession | a BuildingLookupSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsBuildingLookup()
and supportsVisibleFederation() are true | |
Method | getBuildingQuerySession | ||
Description |
Gets the | ||
Return | osid.room.BuildingQuerySession | a BuildingQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBuildingQuery() is false | ||
Compliance | optional | This method must be implemented if supportsBuildingQuery()
is true. | |
Method | getBuildingQuerySessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.id.Id | campusId | the Id of the Building |
Return | osid.room.BuildingQuerySession | a BuildingQuerySession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsBuildingQuery()
and supportsVisibleFederation() are true | |
Method | getBuildingSearchSession | ||
Description |
Gets the | ||
Return | osid.room.BuildingSearchSession | a BuildingSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBuildingSearch() is false | ||
Compliance | optional | This method must be implemented if supportsBuildingSearch()
is true. | |
Method | getBuildingSearchSessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.id.Id | campusId | the Id of the Building |
Return | osid.room.BuildingSearchSession | a BuildingSearchSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsBuildingSearch()
and supportsVisibleFederation() are true | |
Method | getBuildingAdminSession | ||
Description |
Gets the | ||
Return | osid.room.BuildingAdminSession | a BuildingAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBuildingAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsBuildingAdmin()
is true. | |
Method | getBuildingAdminSessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.id.Id | campusId | the Id of the Building |
Return | osid.room.BuildingAdminSession | a BuildingAdminSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsBuildingAdmin()
and supportsVisibleFederation() are true | |
Method | getBuildingNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.room.BuildingReceiver | buildingReceiver | the receiver |
Return | osid.room.BuildingNotificationSession | a BuildingNotificationSession | |
Errors | NULL_ARGUMENT | buildingReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBuildingNotification() is false | ||
Compliance | optional | This method must be implemented if supportsBuildingNotification()
is true. | |
Method | getBuildingNotificationSessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.room.BuildingReceiver | buildingReceiver | the receiver |
osid.id.Id | campusId | the Id of the Campus | |
Return | osid.room.BuildingNotificationSession | a BuildingNotificationSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsBuildingNotification()
and supportsVisibleFederation() are true | |
Method | getBuildingCampusSession | ||
Description |
Gets the session for retrieving building to campus mappings. | ||
Return | osid.room.BuildingCampusSession | a BuildingCampusSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBuildingCampus() is false | ||
Compliance | optional | This method must be implemented if supportsBuildingCampus()
is true. | |
Method | getBuildingCampusAssignmentSession | ||
Description |
Gets the session for assigning building to campus mappings. | ||
Return | osid.room.BuildingCampusAssignmentSession | a BuildingCampusAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBuildingCampusAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsBuildingCampusAssignment() is true. | |
Method | getBuildingSmartCampusSession | ||
Description |
Gets the session associated with the building smart campus for the given campus. | ||
Parameters | osid.id.Id | campusId | the Id of the campus |
Return | osid.room.BuildingSmartCampusSession | a BuildingSmartCampusSession | |
Errors | NOT_FOUND | campusId not found | |
NULL_ARGUMENT | campusId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBuildingSmartCampus() is false | ||
Compliance | optional | This method must be implemented if supportsBuildingSmartCampus()
is true. | |
Method | getCampusLookupSession | ||
Description |
Gets the | ||
Return | osid.room.CampusLookupSession | a CampusLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCampusLookup() is false | ||
Compliance | optional | This method must be implemented if supportsCampusLookup() is
true. | |
Method | getCampusQuerySession | ||
Description |
Gets the | ||
Return | osid.room.CampusQuerySession | a CampusQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCampusQuery() is false | ||
Compliance | optional | This method must be implemented if supportsCampusQuery() is
true. | |
Method | getCampusSearchSession | ||
Description |
Gets the | ||
Return | osid.room.CampusSearchSession | a CampusSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCampusSearch() is false | ||
Compliance | optional | This method must be implemented if supportsCampusSearch() is
true. | |
Method | getCampusAdminSession | ||
Description |
Gets the | ||
Return | osid.room.CampusAdminSession | a CampusAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCampusAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsCampusAdmin() is
true. | |
Method | getCampusNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.room.CampusReceiver | campusReceiver | the receiver |
Return | osid.room.CampusNotificationSession | a CampusNotificationSession | |
Errors | NULL_ARGUMENT | campusReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCampusNotification() is false | ||
Compliance | optional | This method must be implemented if supportsCampusNotification()
is true. | |
Method | getCampusHierarchySession | ||
Description |
Gets the | ||
Return | osid.room.CampusHierarchySession | a CampusHierarchySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCampusHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsCampusHierarchy()
is true. | |
Method | getCampusHierarchyDesignSession | ||
Description |
Gets the | ||
Return | osid.room.CampusHierarchyDesignSession | a CampusHierarchyDesignSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCampusHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if supportsCampusHierarchyDesign()
is true. | |
Method | getRoomBatchManager | ||
Description |
Gets the | ||
Return | osid.room.batch.RoomBatchManager | a RoomBatchManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRoombatch() is false | ||
Compliance | optional | This method must be implemented if supportsRoombatch() is
true. | |
Method | getRoomConstructionManager | ||
Description |
Gets the | ||
Return | osid.room.construction.RoomConstructionManager | a RoomConstructionManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRoomConstruction() is false | ||
Compliance | optional | This method must be implemented if supportsRoomConstruction()
is true. | |
Method | getRoomSquattingManager | ||
Description |
Gets the | ||
Return | osid.room.squatting.RoomSquattingManager | a RoomSquattingManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRoomSquatting() is false | ||
Compliance | optional | This method must be implemented if supportsRoomSquatting()
is true. |