| Interface | osid.calendaring.batch.ScheduleSlotBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.calendaring.ScheduleSlotAdminSession | ||
| 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 | getScheduleSlotFormsForCreate | ||
| Description | 
                     Gets the schedule slot forms for creating a bunch of new schedule slots.  | ||
| Parameters | cardinal | number | the number of forms to retrieve | 
osid.type.Type[] | scheduleSlotRecordTypes | array of schedule slot record types to be included in each create operation or an empty list if none | |
| Return | osid.calendaring.batch.ScheduleSlotBatchFormList | the schedule slot forms | |
| Errors | NULL_ARGUMENT |  scheduleSlotRecordTypes  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 | createScheduleSlots | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.calendaring.batch.ScheduleSlotBatchFormList | scheduleSlotForms | the schedule slot forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  scheduleSlotForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getScheduleSlotFormsForUpdate | ||
| Description | 
                     Gets the schedule slot forms for updating an existing set of schedule slots. A new schedule slot form should be requested for each update transaction.  | ||
| Parameters | osid.id.IdList | scheduleSlotIds | the  Ids  of the  ScheduleSlot   | 
| Return | osid.calendaring.batch.ScheduleSlotBatchFormList | the schedule slot form | |
| Errors | NOT_FOUND | a  scheduleSlotId  is not found  |                 |
| NULL_ARGUMENT |  scheduleSlotIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateScheduleSlots | ||
| Description | 
                     Updates existing schedule slots. This method returns an 
                    error if the entire operation fails. Otherwise, the status 
                    of an individual update operation is indicated in the 
                      | ||
| Parameters | osid.calendaring.batch.ScheduleSlotBatchFormList | scheduleSlotForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  scheduleSlotForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllScheduleSlots | ||
| 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 | deleteScheduleSlots | ||
| Description | 
                     Deletes schedule slots for the given   | ||
| Parameters | osid.id.IdList | scheduleSlotIds | the  Ids  of the schedule slots to delete  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  scheduleSlotIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteContainedScheduleSlots | ||
| Description | 
                     Deletes schedule slots contained within the given schedule slot.  | ||
| Parameters | osid.id.Id | scheduleSlotId | the  Id  of a schedule slot  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  scheduleSlotId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | aliasScheduleSlots | ||
| 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. | |