Interface | osid.room.batch.FloorBatchAdminSession | ||
---|---|---|---|
Implements | osid.room.FloorAdminSession | ||
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 | getFloorFormsForCreate | ||
Description |
Gets the floor forms for creating a bunch of new
floors. A FloorForm is returned for each building | ||
Parameters | osid.id.IdList | buildingIds | an Id of a building |
osid.type.Type[] | floorRecordTypes | array of floor record types to be included in each create operation or an empty list if none | |
Return | osid.room.batch.FloorBatchFormList | the floor forms | |
Errors | NOT_FOUND | a buildingId is not found | |
NULL_ARGUMENT | buildingId or floorRecordTypes 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 | createFloors | ||
Description |
Creates a new set of | ||
Parameters | osid.room.batch.FloorBatchFormList | floorForms | the floor forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | floorForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFloorFormsForUpdate | ||
Description |
Gets the floor forms for updating an existing set of floors. A new floor form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | floorIds | the Ids of the Floor |
Return | osid.room.batch.FloorBatchFormList | the floor form | |
Errors | NOT_FOUND | a floorId is not found | |
NULL_ARGUMENT | floorIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateFloors | ||
Description |
Updates existing floors. 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.FloorBatchFormList | floorForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | floorForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllFloors | ||
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 | deleteFloors | ||
Description |
Deletes floors for the given | ||
Parameters | osid.id.IdList | floorIds | the Ids of the floors to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | floorIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteFloorsForBuilding | ||
Description |
Deletes all floors for the given building. | ||
Parameters | osid.id.Id | buildingId | an Id of a building |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | buildingId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIneffectiveFloorsByDate | ||
Description |
Deletes floors 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 | aliasFloors | ||
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. |