Interface | osid.calendaring.batch.OffsetEventBatchAdminSession | ||
---|---|---|---|
Implements | osid.calendaring.OffsetEventAdminSession | ||
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 | getOffsetEventFormsForCreate | ||
Description |
Gets the offset event forms for creating a bunch of new offset events. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | offsetEventRecordTypes | array of offset event record types to be included in each create operation or an empty list if none | |
Return | osid.calendaring.batch.OffsetEventBatchFormList | the offset event forms | |
Errors | NULL_ARGUMENT | offsetEventRecordTypes 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 | createOffsetEvents | ||
Description |
Creates a new set of | ||
Parameters | osid.calendaring.batch.OffsetEventBatchFormList | offsetEventForms | the offset event forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | offsetEventForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOffsetEventFormsForUpdate | ||
Description |
Gets the offset event forms for updating an existing set of offset events. A new offset event form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | offsetEventIds | the Ids of the OffsetEvent |
Return | osid.calendaring.batch.OffsetEventBatchFormList | the offset event form | |
Errors | NOT_FOUND | an offsetEventId is not found | |
NULL_ARGUMENT | offsetEventIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateOffsetEvents | ||
Description |
Updates existing offset 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.OffsetEventBatchFormList | offsetEventForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | offsetEventForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllOffsetEvents | ||
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 | deleteOffsetEvents | ||
Description |
Deletes offset events for the given | ||
Parameters | osid.id.IdList | offsetEventIds | the Ids of the offset events to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | offsetEventIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasOffsetEvents | ||
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. |