Interface | osid.calendaring.cycle.batch.CyclicEventBatchAdminSession | ||
---|---|---|---|
Implements | osid.calendaring.cycle.CyclicEventAdminSession | ||
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 | getCyclicEventFormsForCreate | ||
Description |
Gets the cyclic event forms for creating a bunch of new cyclic events. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | cyclicEventRecordTypes | array of cyclic event record types to be included in each create operation or an empty list if none | |
Return | osid.calendaring.cycle.batch.CyclicEventBatchFormList | the cyclic event forms | |
Errors | NULL_ARGUMENT | cyclicEventRecordTypes 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 | createCyclicEvents | ||
Description |
Creates a new set of | ||
Parameters | osid.calendaring.cycle.batch.CyclicEventBatchFormList | cyclicEventForms | the cyclic event forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | cyclicEventForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCyclicEventFormsForUpdate | ||
Description |
Gets the cyclic event forms for updating an existing set of cyclic events. A new cyclic event form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | cyclicEventIds | the Ids of the CyclicEvent |
Return | osid.calendaring.cycle.batch.CyclicEventBatchFormList | the cyclic event form | |
Errors | NOT_FOUND | a cyclicEventId is not found | |
NULL_ARGUMENT | cyclicEventIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCyclicEvents | ||
Description |
Updates existing cyclic 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.cycle.batch.CyclicEventBatchFormList | cyclicEventForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | cyclicEventForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllCyclicEvents | ||
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 | deleteCyclicEvents | ||
Description |
Deletes cyclic events for the given | ||
Parameters | osid.id.IdList | cyclicEventIds | the Ids of the cyclic events to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | cyclicEventIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasCyclicEvents | ||
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. |