| Interface | osid.resourcing.batch.AvailabilityBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.resourcing.AvailabilityAdminSession | ||
| Description | 
                 This session creates, updates, and deletes   Create and update operations differ in their usage. To 
                create an   The   Once a batch of   For updates,   Once a batch of   The delete operations delete   | ||
| Method | getAvailabilityFormsForCreate | ||
| Description | 
                     Gets the availability forms for creating a bunch of new 
                    availabilities. An   | ||
| Parameters | osid.resourcing.batch.AvailabilityPeerList | peers | the relationship peers | 
osid.type.Type[] | availabilityRecordTypes | array of availability record types to be included in each create operation or an empty list if none | |
| Return | osid.resourcing.batch.AvailabilityBatchFormList | the availability forms | |
| Errors | NOT_FOUND | an  effortId  or  resourceId  is not found  |                 |
| NULL_ARGUMENT |  peers  or  availabilityRecordTypes  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 | createAvailabilities | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.resourcing.batch.AvailabilityBatchFormList | availabilityForms | the availability forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  availabilityForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAvailabilityFormsForUpdate | ||
| Description | 
                     Gets the availability forms for updating an existing set of availabilities. A new availability form should be requested for each update transaction.  | ||
| Parameters | osid.id.IdList | availabilityIds | the  Ids  of the  Availability   | 
| Return | osid.resourcing.batch.AvailabilityBatchFormList | the availability form | |
| Errors | NOT_FOUND | an  availabilityId  is not found  |                 |
| NULL_ARGUMENT |  availabilityIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateAvailabilities | ||
| Description | 
                     Updates existing availabilities. This method returns an 
                    error if the entire operation fails. Otherwise, the status 
                    of an individual update operation is indicated in the 
                      | ||
| Parameters | osid.resourcing.batch.AvailabilityBatchFormList | availabilityForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  availabilityForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllAvailabilities | ||
| 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 | deleteAvailabilities | ||
| Description | 
                     Deletes availabilities for the given   | ||
| Parameters | osid.id.IdList | availabilityIds | the  Ids  of the availabilities to delete  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  availabilityIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAvailabilitiesForResource | ||
| Description | 
                     Deletes all availabilities for the given resource.  | ||
| Parameters | osid.id.Id | resourceId | an  Id  of a resource  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  resourceId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAvailabilitiesForJob | ||
| Description | 
                     Deletes all availabilities for the given job.  | ||
| Parameters | osid.id.Id | jobId | an  Id  of a job  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  jobId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteIneffectiveAvailabilitiesByDate | ||
| Description | 
                     Deletes availabilities 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 | aliasAvailabilities | ||
| 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. | |