OSID Logo
OSID Specifications
calendaring batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.batch.ScheduleBatchAdminSession
Implementsosid.calendaring.ScheduleAdminSession
Description

This session creates, updates, and deletes Schedules 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 Schedule, a ScheduleForm is requested using getScheduleFormsForCreate() specifying the desired schedule slot, time period, record Types or none if no record Types are needed. Each of the returned ScheduleForms 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 ScheduleForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ScheduleForm corresponds to an attempted transaction.

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

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

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

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

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

MethodgetScheduleFormsForCreate
Description

Gets the schedule forms for creating a bunch of new schedules. A form is returned for each supplied schedule slot and time period pair.

Parametersosid.calendaring.batch.SchedulePeerListpeersthe schedule peers
osid.type.Type[]scheduleRecordTypesarray of schedule record types to be included in each create operation or an empty list if none
Returnosid.calendaring.batch.ScheduleBatchFormListthe schedule forms
ErrorsNOT_FOUNDa scheduleSlotId or timePeriodId is not found
NULL_ARGUMENT peers or scheduleRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateSchedules
Description

Creates a new set of Schedules. 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.ScheduleBatchFormListscheduleFormsthe schedule forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT scheduleForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetScheduleFormsForUpdate
Description

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

Parametersosid.id.IdListscheduleIdsthe Ids of the Schedule
Returnosid.calendaring.batch.ScheduleBatchFormListthe schedule form
ErrorsNOT_FOUNDa scheduleId is not found
NULL_ARGUMENT scheduleIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateSchedules
Description

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

Deletes all Schedules in this Calendar .

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

Deletes schedules for the given Ids.

Parametersosid.id.IdListscheduleIdsthe Ids of the schedules to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT scheduleIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteSchedulesForScheduleSlot
Description

Deletes schedules for the given schedule slot.

Parametersosid.id.IdscheduleSlotIdan Id of a schedule slot
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT scheduleSlotId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteSchedulesForTimePeriod
Description

Deletes schedules for the given time period.

Parametersosid.id.IdtimePeriodIdan Id of a time period
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT timePeriodId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasSchedules
Description

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