OSID Logo
OSID Specifications
room batch package
Version 3.1.0
Interfaceosid.room.batch.RoomBatchManager
Implementsosid.OsidManager
osid.room.batch.RoomBatchProfile
Used Byosid.room.RoomManager
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.RoomBatchAdminSession a RoomBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRoomBatchAdmin() is false
Complianceoptional This 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.IdcampusId the Id of the Campus
Returnosid.room.batch.RoomBatchAdminSession a RoomBatchAdminSession
ErrorsNOT_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
Complianceoptional This 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.FloorBatchAdminSession a FloorBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFloorBatchAdmin() is false
Complianceoptional This 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.IdcampusId the Id of the Campus
Returnosid.room.batch.FloorBatchAdminSession a FloorBatchAdminSession
ErrorsNOT_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
Complianceoptional This 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.BuildingBatchAdminSession a BuildingBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBuildingBatchAdmin() is false
Complianceoptional This 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.IdcampusId the Id of the Campus
Returnosid.room.batch.BuildingBatchAdminSession a BuildingBatchAdminSession
ErrorsNOT_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
Complianceoptional This 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.CampusBatchAdminSession a CampusBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCampusBatchAdmin() is false
Complianceoptional This method must be implemented if supportsCampusBatchAdmin() is true.