OSID Logo
OSID Specifications
calendaring cycle batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.cycle.batch.CyclicTimePeriodBatchAdminSession
Implementsosid.calendaring.cycle.CyclicTimePeriodAdminSession
Description

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

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

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

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

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

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

MethodgetCyclicTimePeriodFormsForCreate
Description

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

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

Creates a new set of CyclicTimePeriods. 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.cycle.batch.CyclicTimePeriodBatchFormListcyclicTimePeriodFormsthe cyclic time period forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT cyclicTimePeriodForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCyclicTimePeriodFormsForUpdate
Description

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

Parametersosid.id.IdListcyclicTimePeriodIdsthe Ids of the CyclicTimePeriod
Returnosid.calendaring.cycle.batch.CyclicTimePeriodBatchFormListthe cyclic time period form
ErrorsNOT_FOUNDa cyclicTimePeriodId is not found
NULL_ARGUMENT cyclicTimePeriodIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateCyclicTimePeriods
Description

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

Deletes all CyclicTimePeriods in this Calendar .

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

Deletes cyclic time periods for the given Ids.

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

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