org.osid.inquiry.batch

Interface InquestBatchAdminSession

All Superinterfaces:

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

public interface InquestBatchAdminSession
extends InquestAdminSession

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

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

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

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

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

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

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasInquests(AliasRequestList aliasRequests) Adds an Id to an Inquest for the purpose of creating compatibility.
CreateResponseList	createInquests(InquestBatchFormList inquestForms) Creates a new set of Inquests.
DeleteResponseList	deleteAllInquests() Deletes all Inquests.
DeleteResponseList	deleteInquests(IdList inquestIds) Deletes inquests for the given Ids.
InquestBatchFormList	getInquestFormsForCreate(long number, Type[] inquestRecordTypes) Gets the inquest forms for creating a bunch of new inquests.
InquestBatchFormList	getInquestFormsForUpdate(IdList inquestIds) Gets the inquest forms for updating an existing set of inquests.
UpdateResponseList	updateInquests(InquestBatchFormList inquestForms) Updates existing inquests.

Methods inherited from interface org.osid.inquiry.InquestAdminSession

aliasInquest, canCreateInquests, canCreateInquestWithRecordTypes, canDeleteInquests, canManageInquestAliases, canUpdateInquests, createInquest, deleteInquest, getInquestFormForCreate, getInquestFormForUpdate, updateInquest

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

getInquestFormsForCreate

InquestBatchFormList getInquestFormsForCreate(long number,
                                            Type[] inquestRecordTypes)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Gets the inquest forms for creating a bunch of new inquests.

Parameters:

number - the number of forms to retrieve

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

Returns:

the inquest forms

Throws:

NullArgumentException - inquestRecordTypes 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.

createInquests

CreateResponseList createInquests(InquestBatchFormList inquestForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

inquestForms - the inquest forms

Returns:

the create responses

Throws:

NullArgumentException - inquestForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInquestFormsForUpdate

InquestBatchFormList getInquestFormsForUpdate(IdList inquestIds)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

inquestIds - the Ids of the Inquests

Returns:

the inquest form

Throws:

NotFoundException - an inquestId is not found

NullArgumentException - inquestIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateInquests

UpdateResponseList updateInquests(InquestBatchFormList inquestForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

inquestForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - inquestForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllInquests

DeleteResponseList deleteAllInquests()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Deletes all Inquests.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteInquests

DeleteResponseList deleteInquests(IdList inquestIds)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes inquests for the given Ids.

Parameters:

inquestIds - the Ids of the inquests to delete

Returns:

the delete responses

Throws:

NullArgumentException - inquestIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasInquests

AliasResponseList aliasInquests(AliasRequestList aliasRequests)
                                throws OperationFailedException,
                                       PermissionDeniedException

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