Interface | osid.room.batch.RoomBatchManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.room.batch.RoomBatchProfile | |||
Description |
The room batch manager provides access to room batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
Method | getRoomBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.room.batch.RoomBatchAdminSession | a RoomBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRoomBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsRoomBatchAdmin()
is true. | |
Method | getRoomBatchAdminSessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.id.Id | campusId | the Id of the Campus |
Return | osid.room.batch.RoomBatchAdminSession | a RoomBatchAdminSession | |
Errors | NOT_FOUND | no Campus found by the given Id | |
NULL_ARGUMENT | campusId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRoomBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRoomBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getFloorBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.room.batch.FloorBatchAdminSession | a FloorBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsFloorBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsFloorBatchAdmin()
is true. | |
Method | getFloorBatchAdminSessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.id.Id | campusId | the Id of the Campus |
Return | osid.room.batch.FloorBatchAdminSession | a FloorBatchAdminSession | |
Errors | NOT_FOUND | no Campus found by the given Id | |
NULL_ARGUMENT | campusId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsFloorBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsFloorBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getBuildingBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.room.batch.BuildingBatchAdminSession | a BuildingBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBuildingBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsBuildingBatchAdmin()
is true. | |
Method | getBuildingBatchAdminSessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.id.Id | campusId | the Id of the Campus |
Return | osid.room.batch.BuildingBatchAdminSession | a BuildingBatchAdminSession | |
Errors | NOT_FOUND | no Campus found by the given Id | |
NULL_ARGUMENT | campusId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBuildingBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsBuildingBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getCampusBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.room.batch.CampusBatchAdminSession | a CampusBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCampusBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsCampusBatchAdmin()
is true. |