OSID Logo
OSID Specifications
room batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.batch.RoomBatchManager
Implementsosid.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:

  • RoomBatchAdminSession: a session to create, modify and delete Rooms in bulk
  • FloorBatchAdminSession: a session to create, modify and delete Floors in bulk
  • BuildingBatchAdminSession: a session to create, modify and delete Buildings in bulk
  • CampusBatchAdminSession: a session to create, modify and delete Campuses in bulk
MethodgetRoomBatchAdminSession
Description

Gets the OsidSession associated with the bulk room administration service.

Returnosid.room.batch.RoomBatchAdminSessiona RoomBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRoomBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsRoomBatchAdmin() is true.
MethodgetRoomBatchAdminSessionForCampus
Description

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

Parametersosid.id.IdcampusIdthe Id of the Campus
Returnosid.room.batch.RoomBatchAdminSessiona RoomBatchAdminSession
ErrorsNOT_FOUNDno Campus found by the given Id
NULL_ARGUMENT campusId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRoomBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRoomBatchAdmin() and supportsVisibleFederation() are true
MethodgetFloorBatchAdminSession
Description

Gets the OsidSession associated with the bulk floor administration service.

Returnosid.room.batch.FloorBatchAdminSessiona FloorBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFloorBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsFloorBatchAdmin() is true.
MethodgetFloorBatchAdminSessionForCampus
Description

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

Parametersosid.id.IdcampusIdthe Id of the Campus
Returnosid.room.batch.FloorBatchAdminSessiona FloorBatchAdminSession
ErrorsNOT_FOUNDno Campus found by the given Id
NULL_ARGUMENT campusId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFloorBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsFloorBatchAdmin() and supportsVisibleFederation() are true
MethodgetBuildingBatchAdminSession
Description

Gets the OsidSession associated with the bulk building administration service.

Returnosid.room.batch.BuildingBatchAdminSessiona BuildingBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBuildingBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsBuildingBatchAdmin() is true.
MethodgetBuildingBatchAdminSessionForCampus
Description

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

Parametersosid.id.IdcampusIdthe Id of the Campus
Returnosid.room.batch.BuildingBatchAdminSessiona BuildingBatchAdminSession
ErrorsNOT_FOUNDno Campus found by the given Id
NULL_ARGUMENT campusId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBuildingBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBuildingBatchAdmin() and supportsVisibleFederation() are true
MethodgetCampusBatchAdminSession
Description

Gets the OsidSession associated with the bulk campus administration service.

Returnosid.room.batch.CampusBatchAdminSessiona CampusBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCampusBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsCampusBatchAdmin() is true.