Interface | osid.room.construction.batch.RenovationBatchAdminSession | ||
---|---|---|---|
Implements | osid.room.construction.RenovationAdminSession | ||
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 | getRenovationFormsForCreate | ||
Description |
Gets the renovation forms for creating a bunch of new renovations. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | renovationRecordTypes | array of renovation record types to be included in each create operation or an empty list if none | |
Return | osid.room.construction.batch.RenovationBatchFormList | the renovation forms | |
Errors | NULL_ARGUMENT | renovationRecordTypes 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 | createRenovations | ||
Description |
Creates a new set of | ||
Parameters | osid.room.construction.batch.RenovationBatchFormList | renovationForms | the renovation forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | renovationForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRenovationFormsForUpdate | ||
Description |
Gets the renovation forms for updating an existing set of renovations. A new renovation form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | renovationIds | the Ids of the Renovation |
Return | osid.room.construction.batch.RenovationBatchFormList | the renovation form | |
Errors | NOT_FOUND | a renovationId is not found | |
NULL_ARGUMENT | renovationIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateRenovations | ||
Description |
Updates existing renovations. 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.construction.batch.RenovationBatchFormList | renovationForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | renovationForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllRenovations | ||
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 | deleteRenovations | ||
Description |
Deletes renovations for the given | ||
Parameters | osid.id.IdList | renovationIds | the Ids of the renovations to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | renovationIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIneffectiveRenovationsByDate | ||
Description |
Deletes renovations 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 | aliasRenovations | ||
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. |