OSID Logo
OSID Specifications
calendaring batch package
Version 3.1.0
Interfaceosid.calendaring.batch.RecurringEventBatchAdminSession
Implementsosid.calendaring.RecurringEventAdminSession
Used Byosid.calendaring.batch.CalendaringBatchManager
osid.calendaring.batch.CalendaringBatchProxyManager
Description

This session creates, updates, and deletes RecurringEvents in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a RecurringEvent, a RecurringEventForm is requested using getRecurringEventFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned RecurringEventForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once a RecurringEventForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each RecurringEventForm corresponds to an attempted transaction.

The RecurringEventForms returned from getRecurringEventFormsForCreate() may be linked to the originating request through the peer Ids of the RecurringEventForm. In the case where there may be duplicates, any RecurringEventForm of the same peer Ids may be used for a create operation.

Once a batch of RecurringEventForms are submitted for create, a CreateResponse is returned for each RecurringEventForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createRecurringEvents(), errors specific to an individual RecurringEventForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating RecurringEventForm through the RecurringEventForm Id.

For updates, RecurringEventForms are requested to the RecurringEvent Id that is to be updated using getRecurringEventFormsForUpdate() where the reference Id in the RecurringEventForm may be used to link the request. Similarly, the RecurringEventForm has metadata about the data that can be updated and it can perform validation before submitting the update. The RecurringEventForm can only be used once for a successful update and cannot be reused.

Once a batch of RecurringEventForms are submitted for update, an UpdateResponse is returned for each RecurringEventForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateRecurringEvents(), errors specific to an individual RecurringEventForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating RecurringEventForm through the RecurringEventForm Id.

The delete operations delete RecurringEvents in bulk. To unmap a RecurringEvent from the current Calendar, the RecurringEventCalendarAssignmentSession should be used. These delete operations attempt to remove the RecurringEvent itself thus removing it from all known Calendar catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetRecurringEventFormsForCreate
Description

Gets the recurring eventforms for creating a bunch of new recurring events.

Parameterscardinalnumber 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
Returnosid.calendaring.batch.RecurringEventBatchFormList the recurring eventforms
ErrorsNULL_ARGUMENT recurringEventRecordTypes is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED unable to request forms with given record types
Compliancemandatory This method must be implemented.
MethodcreateRecurringEvents
Description

Creates a new set of RecurringEvents. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse.

Parametersosid.calendaring.batch.RecurringEventBatchFormListrecurringEventForms the recurring event forms
Returnosid.transaction.batch.CreateResponseList the create responses
ErrorsNULL_ARGUMENT recurringEventForms is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetRecurringEventFormsForUpdate
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.

Parametersosid.id.IdListrecurringEventIds the Ids of the RecurringEvent
Returnosid.calendaring.batch.RecurringEventBatchFormList the recurring event form
ErrorsNOT_FOUND a recurringEventId is not found
NULL_ARGUMENT recurringEventIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodupdateRecurringEvents
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 BatchCreateResponse.

Parametersosid.calendaring.batch.RecurringEventBatchFormListrecurringEventForms the form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseList the update responses
ErrorsNULL_ARGUMENT recurringEventForms is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteAllRecurringEvents
Description

Deletes all RecurringEvents in this Calendar.

Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteRecurringEvents
Description

Deletes recurring events for the given Ids.

Parametersosid.id.IdListrecurringEventIds the Ids of the recurring events to delete
Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsNULL_ARGUMENT recurringEventIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodaliasRecurringEvents
Description

Adds an Id to a RecurringEvent for the purpose of creating compatibility. The primary Id of the RecurringEvent is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another recurring event, it is reassigned to the given recurring event Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequests the alias requests
Returnosid.transaction.batch.AliasResponseList the alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.