Interface | osid.calendaring.batch.EventBatchAdminSession | ||
---|---|---|---|
Implements | osid.calendaring.EventAdminSession | ||
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 | getEventFormsForCreate | ||
Description |
Gets the event forms for creating a bunch of new events. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | eventRecordTypes | array of event record types to be included in each create operation or an empty list if none | |
Return | osid.calendaring.batch.EventBatchFormList | the event forms | |
Errors | NULL_ARGUMENT | eventRecordTypes 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 | createEvents | ||
Description |
Creates a new set of | ||
Parameters | osid.calendaring.batch.EventBatchFormList | eventForms | the event forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | eventForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEventFormsForUpdate | ||
Description |
Gets the event forms for updating an existing set of events. A new event form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | eventIds | the Ids of the Event |
Return | osid.calendaring.batch.EventBatchFormList | the event form | |
Errors | NOT_FOUND | an eventId is not found | |
NULL_ARGUMENT | eventIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateEvents | ||
Description |
Updates existing 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.EventBatchFormList | eventForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | eventForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllEvents | ||
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 | deleteEvents | ||
Description |
Deletes events for the given | ||
Parameters | osid.id.IdList | eventIds | the Ids of the events to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | eventIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasEvents | ||
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. |