OSID Logo
OSID Specifications
calendaring batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.batch.CalendarBatchAdminSession
Implementsosid.calendaring.CalendarAdminSession
Description

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

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

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

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

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

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

MethodgetCalendarFormsForCreate
Description

Gets the calendar forms for creating a bunch of new calendars.

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

Creates a new set of Calendars. 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.CalendarBatchFormListcalendarFormsthe calendar forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT calendarForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCalendarFormsForUpdate
Description

Gets the calendar forms for updating an existing set of calendars. A new calendar form should be requested for each update transaction.

Parametersosid.id.IdListcalendarIdsthe Ids of the Calendar
Returnosid.calendaring.batch.CalendarBatchFormListthe calendar form
ErrorsNOT_FOUNDa calendarId is not found
NULL_ARGUMENT calendarIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateCalendars
Description

Updates existing calendars. 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.CalendarBatchFormListcalendarFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT calendarForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllCalendars
Description

Deletes all Calendars in this Calendar .

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

Deletes calendars for the given Ids.

Parametersosid.id.IdListcalendarIdsthe Ids of the calendars to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT calendarIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasCalendars
Description

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