OSID Logo
OSID Specifications
checklist batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.batch.ChecklistBatchAdminSession
Implementsosid.checklist.ChecklistAdminSession
Description

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

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

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

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

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

The delete operations delete Checklists in bulk. Bulk delete operations return the results in DeleteResponses.

MethodgetChecklistFormsForCreate
Description

Gets the checklist forms for creating a bunch of new checklists.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]checklistRecordTypesarray of checklist record types to be included in each create operation or an empty list if none
Returnosid.checklist.batch.ChecklistBatchFormListthe checklist forms
ErrorsNULL_ARGUMENT checklistRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateChecklists
Description

Creates a new set of Checklists. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.checklist.batch.ChecklistBatchFormListchecklistFormsthe checklist forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT checklistForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChecklistFormsForUpdate
Description

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

Parametersosid.id.IdListchecklistIdsthe Ids of the Checklist
Returnosid.checklist.batch.ChecklistBatchFormListthe checklist form
ErrorsNOT_FOUNDan checklistId is not found
NULL_ARGUMENT checklistIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateChecklists
Description

Updates existing checklists. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parametersosid.checklist.batch.ChecklistBatchFormListchecklistFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT checklistForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllChecklists
Description

Deletes all Checklists.

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

Deletes checklists for the given Ids.

Parametersosid.id.IdListchecklistIdsthe Ids of the checklists to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT checklistIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasChecklists
Description

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