org.osid.checklist.batch

Interface ChecklistBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, ChecklistAdminSession, java.io.Closeable, OsidSession

public interface ChecklistBatchAdminSession
extends ChecklistAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasChecklists(AliasRequestList aliasRequests) Adds an Id to an Checklist for the purpose of creating compatibility.
CreateResponseList	createChecklists(ChecklistBatchFormList checklistForms) Creates a new set of Checklists.
DeleteResponseList	deleteAllChecklists() Deletes all Checklists.
DeleteResponseList	deleteChecklists(IdList checklistIds) Deletes checklists for the given Ids.
ChecklistBatchFormList	getChecklistFormsForCreate(long number, Type[] checklistRecordTypes) Gets the checklist forms for creating a bunch of new checklists.
ChecklistBatchFormList	getChecklistFormsForUpdate(IdList checklistIds) Gets the checklist forms for updating an existing set of checklists.
UpdateResponseList	updateChecklists(ChecklistBatchFormList checklistForms) Updates existing checklists.

Methods inherited from interface org.osid.checklist.ChecklistAdminSession

aliasChecklist, canCreateChecklists, canCreateChecklistWithRecordTypes, canDeleteChecklists, canManageChecklistAliases, canUpdateChecklists, createChecklist, deleteChecklist, getChecklistFormForCreate, getChecklistFormForUpdate, updateChecklist

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getChecklistFormsForCreate

ChecklistBatchFormList getChecklistFormsForCreate(long number,
                                                Type[] checklistRecordTypes)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

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

Parameters:

number - the number of forms to retrieve

checklistRecordTypes - array of checklist record types to be included in each create operation or an empty list if none

Returns:

the checklist forms

Throws:

NullArgumentException - checklistRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createChecklists

CreateResponseList createChecklists(ChecklistBatchFormList checklistForms)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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 .

Parameters:

checklistForms - the checklist forms

Returns:

the create responses

Throws:

NullArgumentException - checklistForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChecklistFormsForUpdate

ChecklistBatchFormList getChecklistFormsForUpdate(IdList checklistIds)
                                                  throws NotFoundException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

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

Parameters:

checklistIds - the Ids of the Checklist

Returns:

the checklist form

Throws:

NotFoundException - an checklistId is not found

NullArgumentException - checklistIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateChecklists

UpdateResponseList updateChecklists(ChecklistBatchFormList checklistForms)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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 .

Parameters:

checklistForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - checklistForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllChecklists

DeleteResponseList deleteAllChecklists()
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes all Checklists.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteChecklists

DeleteResponseList deleteChecklists(IdList checklistIds)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Deletes checklists for the given Ids.

Parameters:

checklistIds - the Ids of the checklists to delete

Returns:

the delete responses

Throws:

NullArgumentException - checklistIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasChecklists

AliasResponseList aliasChecklists(AliasRequestList aliasRequests)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.