OSID Logo
OSID Specifications
calendaring batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.batch.TimePeriodBatchAdminSession
Implementsosid.calendaring.TimePeriodAdminSession
Description

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

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

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

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

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

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

MethodgetTimePeriodFormsForCreate
Description

Gets the time period forms for creating a bunch of new time periods.

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

Creates a new set of TimePeriods. 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.TimePeriodBatchFormListtimePeriodFormsthe time period forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT timePeriodForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTimePeriodFormsForUpdate
Description

Gets the time period forms for updating an existing set of time periods. A new time period form should be requested for each update transaction.

Parametersosid.id.IdListtimePeriodIdsthe Ids of the TimePeriod
Returnosid.calendaring.batch.TimePeriodBatchFormListthe time period form
ErrorsNOT_FOUNDa timePeriodId is not found
NULL_ARGUMENT timePeriodIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateTimePeriods
Description

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

Deletes all TimePeriods in this Calendar .

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

Deletes time periods for the given Ids.

Parametersosid.id.IdListtimePeriodIdsthe Ids of the time periods to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT timePeriodIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteTimePeriodsByDate
Description

Deletes time periods containing the given date.

Parametersosid.calendaring.DateTimedatea date
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasTimePeriods
Description

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