| Interface | osid.room.batch.RoomBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.room.RoomAdminSession | ||
| Description | 
                 This session creates, updates, and deletes   Create and update operations differ in their usage. To 
                create a   The   Once a batch of   For updates,   Once a batch of   The delete operations delete   | ||
| Method | getRoomFormsForCreate | ||
| Description | 
                     Gets the room forms for creating a bunch of new rooms. A form is returned for each supplied floor.  | ||
| Parameters | osid.id.IdList | floorIds | a list of floor  Ids   | 
osid.type.Type[] | roomRecordTypes | array of room record types to be included in each create operation or an empty list if none | |
| Return | osid.room.batch.RoomBatchFormList | the room forms | |
| Errors | NOT_FOUND | a  floorId  is not found  |                 |
| NULL_ARGUMENT |  floorIds  or  roomRecordTypes  is  null 
  |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | unable to request forms with given record types | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | createRooms | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.room.batch.RoomBatchFormList | roomForms | the room forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  roomForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getRoomFormsForUpdate | ||
| Description | 
                     Gets the room forms for updating an existing set of rooms. A new room form should be requested for each update transaction.  | ||
| Parameters | osid.id.IdList | roomIds | the  Ids  of the  Room   | 
| Return | osid.room.batch.RoomBatchFormList | the room form | |
| Errors | NOT_FOUND | a  roomId  is not found  |                 |
| NULL_ARGUMENT |  roomIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateRooms | ||
| 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   | ||
| Parameters | osid.room.batch.RoomBatchFormList | roomForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  roomForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllRooms | ||
| Description | 
                     Deletes all   | ||
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteRooms | ||
| Description | 
                     Deletes rooms for the given   | ||
| Parameters | osid.id.IdList | roomIds | the  Ids  of the rooms to delete  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  roomIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteRoomsForFloor | ||
| Description | 
                     Deletes rooms on the given floor.  | ||
| Parameters | osid.id.Id | roomId | the  Id  of a floor  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  floorId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteIneffectiveRoomsByDate | ||
| Description | 
                     Deletes rooms expired before the given date.  | ||
| Parameters | osid.calendaring.DateTime | date | a date | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  date  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | aliasRooms | ||
| Description | 
                     Adds an   | ||
| Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests | 
| Return | osid.transaction.batch.AliasResponseList | the alias responses | |
| Errors | NULL_ARGUMENT |  aliasRequests  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |