OSID Logo
OSID Specifications
calendaring batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.batch.CommitmentBatchAdminSession
Implementsosid.calendaring.CommitmentAdminSession
Description

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

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

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

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

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

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

MethodgetCommitmentFormsForCreate
Description

Gets the commitmentforms for creating a bunch of new commitments. A form is returned for each supplied event and resource pair.

Parametersosid.calendaring.batch.CommitmentPeerListpeersa list of commitment peers
osid.type.Type[]commitmentRecordTypesarray of commitment record types to be included in each create operation or an empty list if none
Returnosid.calendaring.batch.CommitmentBatchFormListthe commitment forms
ErrorsNOT_FOUNDan eventId or resourceId is not found
NULL_ARGUMENT peers or commitmentRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateCommitments
Description

Creates a new set of Commitments. 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.CommitmentBatchFormListcommitmentFormsthe commitment forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT commitmentForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCommitmentFormsForUpdate
Description

Gets the commitment forms for updating an existing set of commitments. A new commitmentform should be requested for each update transaction.

Parametersosid.id.IdListcommitmentIdsthe Ids of the Commitment
Returnosid.calendaring.batch.CommitmentBatchFormListthe commitment form
ErrorsNOT_FOUNDa commitmentId is not found
NULL_ARGUMENT commitmentIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateCommitments
Description

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

Deletes all Commitments in this Calendar .

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

Deletes commitments for the given Ids.

Parametersosid.id.IdListcommitmentIdsthe Ids of the commitments to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT commitmentIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteCommitmentsForEvent
Description

Deletes all commitments related to the given event.

Parametersosid.id.IdeventIdan Id of an event
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT eventId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteCommitmentsForResource
Description

Deletes all commitments related to the given resource.

Parametersosid.id.IdresourceIdan Id of a resource
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveCommitmentsByDate
Description

Deletes all commitments expired before 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.
MethodaliasCommitments
Description

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