| Interface | osid.calendaring.batch.RecurringEventBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.calendaring.RecurringEventAdminSession | ||
| 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 | getRecurringEventFormsForCreate | ||
| Description | 
                     Gets the recurring eventforms for creating a bunch of new recurring events.  | ||
| Parameters | cardinal | number | the number of forms to retrieve | 
osid.type.Type[] | recurringEventRecordTypes | array of recurring event record types to be included in each create operation or an empty list if none | |
| Return | osid.calendaring.batch.RecurringEventBatchFormList | the recurring eventforms | |
| Errors | NULL_ARGUMENT |  recurringEventRecordTypes  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 | createRecurringEvents | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.calendaring.batch.RecurringEventBatchFormList | recurringEventForms | the recurring event forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  recurringEventForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getRecurringEventFormsForUpdate | ||
| Description | 
                     Gets the recurring event forms for updating an existing set of recurring events. A new recurring eventform should be requested for each update transaction.  | ||
| Parameters | osid.id.IdList | recurringEventIds | the  Ids  of the  RecurringEvent   | 
| Return | osid.calendaring.batch.RecurringEventBatchFormList | the recurring event form | |
| Errors | NOT_FOUND | a  recurringEventId  is not found  |                 |
| NULL_ARGUMENT |  recurringEventIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateRecurringEvents | ||
| Description | 
                     Updates existing recurring events. 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.RecurringEventBatchFormList | recurringEventForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  recurringEventForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllRecurringEvents | ||
| 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 | deleteRecurringEvents | ||
| Description | 
                     Deletes recurring events for the given   | ||
| Parameters | osid.id.IdList | recurringEventIds | the  Ids  of the recurring events to delete  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  recurringEventIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | aliasRecurringEvents | ||
| 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. | |