| Interface | osid.room.batch.BuildingBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.room.BuildingAdminSession | ||
| 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 | getBuildingFormsForCreate | ||
| Description | 
                     Gets the building forms for creating a bunch of new buildings.  | ||
| Parameters | cardinal | number | the number of forms to retrieve | 
osid.type.Type[] | buildingRecordTypes | array of building record types to be included in each create operation or an empty list if none | |
| Return | osid.room.batch.BuildingBatchFormList | the building forms | |
| Errors | NULL_ARGUMENT |  buildingRecordTypes  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 | createBuildings | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.room.batch.BuildingBatchFormList | buildingForms | the building forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  buildingForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getBuildingFormsForUpdate | ||
| Description | 
                     Gets the building forms for updating an existing set of buildings. A new building form should be requested for each update transaction.  | ||
| Parameters | osid.id.IdList | buildingIds | the  Ids  of the  Building   | 
| Return | osid.room.batch.BuildingBatchFormList | the building form | |
| Errors | NOT_FOUND | a  buildingId  is not found  |                 |
| NULL_ARGUMENT |  buildingIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateBuildings | ||
| Description | 
                     Updates existing buildings. 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.BuildingBatchFormList | buildingForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  buildingForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllBuildings | ||
| 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 | deleteBuildings | ||
| Description | 
                     Deletes buildings for the given   | ||
| Parameters | osid.id.IdList | buildingIds | the  Ids  of the buildings to delete  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  buildingIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteIneffectiveBuildingsByDate | ||
| Description | 
                     Deletes buildings 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 | aliasBuildings | ||
| 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. | |