OSID Logo
OSID Specifications
calendaring cycle batch package
Version 3.1.0
Interfaceosid.calendaring.cycle.batch.CyclicEventBatchAdminSession
Implementsosid.calendaring.cycle.CyclicEventAdminSession
Used Byosid.calendaring.cycle.batch.CalendaringCycleBatchManager
osid.calendaring.cycle.batch.CalendaringCycleBatchProxyManager
Description

This session creates, updates, and deletes CyclicEvents 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 CyclicEvent, a CyclicEventForm is requested using getCyclicEventFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned CyclicEventForms 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 CyclicEventForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each CyclicEventForm corresponds to an attempted transaction.

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

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

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

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

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

MethodgetCyclicEventFormsForCreate
Description

Gets the cyclic event forms for creating a bunch of new cyclic events.

Parameterscardinalnumber 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
Returnosid.calendaring.cycle.batch.CyclicEventBatchFormList the cyclic event forms
ErrorsNULL_ARGUMENT cyclicEventRecordTypes 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.
MethodcreateCyclicEvents
Description

Creates a new set of CyclicEvents. 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.cycle.batch.CyclicEventBatchFormListcyclicEventForms the cyclic event forms
Returnosid.transaction.batch.CreateResponseList the create responses
ErrorsNULL_ARGUMENT cyclicEventForms is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetCyclicEventFormsForUpdate
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.

Parametersosid.id.IdListcyclicEventIds the Ids of the CyclicEvent
Returnosid.calendaring.cycle.batch.CyclicEventBatchFormList the cyclic event form
ErrorsNOT_FOUND a cyclicEventId is not found
NULL_ARGUMENT cyclicEventIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodupdateCyclicEvents
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 BatchCreateResponse.

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

Deletes all CyclicEvents 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.
MethoddeleteCyclicEvents
Description

Deletes cyclic events for the given Ids.

Parametersosid.id.IdListcyclicEventIds the Ids of the cyclic events to delete
Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsNULL_ARGUMENT cyclicEventIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodaliasCyclicEvents
Description

Adds an Id to a CyclicEvent for the purpose of creating compatibility. The primary Id of the CyclicEvent is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another cyclic event, it is reassigned to the given cyclic 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.