OSID Logo
OSID Specifications
room batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.batch.RoomBatchAdminSession
Implementsosid.room.RoomAdminSession
Description

This session creates, updates, and deletes Rooms in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Room, a RoomForm is requested using getRoomFormsForCreate() specifying the desired floor and record Types or none if no record Types are needed. Each of the returned RoomForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once a RoomForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each RoomForm corresponds to an attempted transaction.

The RoomForms returned from getRoomFormsForCreate() may be linked to the originating request through the peer Ids of the RoomForm. In the case where there may be duplicates, any RoomForm of the same peer Ids may be used for a create operation.

Once a batch of RoomForms are submitted for create, a CreateResponse is returned for each RoomForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createRooms(), errors specific to an individual RoomForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating RoomForm through the RoomForm Id .

For updates, RoomForms are requested to the Room Id that is to be updated using getRoomFormsForUpdate() where the reference Id in the RoomForm may be used to link the request. Similarly, the RoomForm has metadata about the data that can be updated and it can perform validation before submitting the update. The RoomForm can only be used once for a successful update and cannot be reused.

Once a batch of RoomForms are submitted for update, an UpdateResponse is returned for each RoomForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateRooms(), errors specific to an individual RoomForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating RoomForm through the RoomForm Id.

The delete operations delete Rooms in bulk. To unmap a Room from the current Campus, the RoomCampusAssignmentSession should be used. These delete operations attempt to remove the Room itself thus removing it from all known Campus catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetRoomFormsForCreate
Description

Gets the room forms for creating a bunch of new rooms. A form is returned for each supplied floor.

Parametersosid.id.IdListfloorIdsa list of floor Ids
osid.type.Type[]roomRecordTypesarray of room record types to be included in each create operation or an empty list if none
Returnosid.room.batch.RoomBatchFormListthe room forms
ErrorsNOT_FOUNDa floorId is not found
NULL_ARGUMENT floorIds or roomRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateRooms
Description

Creates a new set of Rooms. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.room.batch.RoomBatchFormListroomFormsthe room forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT roomForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRoomFormsForUpdate
Description

Gets the room forms for updating an existing set of rooms. A new room form should be requested for each update transaction.

Parametersosid.id.IdListroomIdsthe Ids of the Room
Returnosid.room.batch.RoomBatchFormListthe room form
ErrorsNOT_FOUNDa roomId is not found
NULL_ARGUMENT roomIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateRooms
Description

Updates existing rooms. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parametersosid.room.batch.RoomBatchFormListroomFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT roomForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllRooms
Description

Deletes all Rooms in this Campus .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteRooms
Description

Deletes rooms for the given Ids.

Parametersosid.id.IdListroomIdsthe Ids of the rooms to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT roomIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteRoomsForFloor
Description

Deletes rooms on the given floor.

Parametersosid.id.IdroomIdthe Id of a floor
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT floorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveRoomsByDate
Description

Deletes rooms expired before the given date.

Parametersosid.calendaring.DateTimedatea date
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasRooms
Description

Adds an Id to a Room for the purpose of creating compatibility. The primary Id of the Room is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another room, it is reassigned to the given entry Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.