OSID Logo
OSID Specifications
calendaring batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.batch.ScheduleSlotBatchAdminSession
Implementsosid.calendaring.ScheduleSlotAdminSession
Description

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

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

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

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

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

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

MethodgetScheduleSlotFormsForCreate
Description

Gets the schedule slot forms for creating a bunch of new schedule slots.

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

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

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

Parametersosid.id.IdListscheduleSlotIdsthe Ids of the ScheduleSlot
Returnosid.calendaring.batch.ScheduleSlotBatchFormListthe schedule slot form
ErrorsNOT_FOUNDa scheduleSlotId is not found
NULL_ARGUMENT scheduleSlotIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateScheduleSlots
Description

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

Deletes all ScheduleSlots in this Calendar .

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

Deletes schedule slots for the given Ids.

Parametersosid.id.IdListscheduleSlotIdsthe Ids of the schedule slots to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT scheduleSlotIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteContainedScheduleSlots
Description

Deletes schedule slots contained within the given schedule slot.

Parametersosid.id.IdscheduleSlotIdthe 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.
MethodaliasScheduleSlots
Description

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