OSID Logo
OSID Specifications
calendaring batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.batch.OffsetEventBatchAdminSession
Implementsosid.calendaring.OffsetEventAdminSession
Description

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

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

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

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

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

The delete operations delete OffsetEvents in bulk. To unmap an OffsetEvent from the current Calendar, the OffsetEventCalendarAssignmentSession should be used. These delete operations attempt to remove the OffsetEvent itself thus removing it from all known Calendar catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetOffsetEventFormsForCreate
Description

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

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]offsetEventRecordTypesarray of offset event record types to be included in each create operation or an empty list if none
Returnosid.calendaring.batch.OffsetEventBatchFormListthe offset event forms
ErrorsNULL_ARGUMENT offsetEventRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateOffsetEvents
Description

Creates a new set of OffsetEvents. 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.OffsetEventBatchFormListoffsetEventFormsthe offset event forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT offsetEventForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOffsetEventFormsForUpdate
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.

Parametersosid.id.IdListoffsetEventIdsthe Ids of the OffsetEvent
Returnosid.calendaring.batch.OffsetEventBatchFormListthe offset event form
ErrorsNOT_FOUNDan offsetEventId is not found
NULL_ARGUMENT offsetEventIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateOffsetEvents
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 BatchCreateResponse .

Parametersosid.calendaring.batch.OffsetEventBatchFormListoffsetEventFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT offsetEventForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllOffsetEvents
Description

Deletes all OffsetEvents in this Calendar .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteOffsetEvents
Description

Deletes offset events for the given Ids.

Parametersosid.id.IdListoffsetEventIdsthe Ids of the offset events to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT offsetEventIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasOffsetEvents
Description

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

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.