org.osid.inquiry.batch

Interface ResponseBatchAdminSession

All Superinterfaces:

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

public interface ResponseBatchAdminSession
extends ResponseAdminSession

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

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

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

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

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

The delete operations delete Responses in bulk. To unmap a Response from the current Inquiry, the ResponseInquiryAssignmentSession should be used. These delete operations attempt to remove the Response itself thus removing it from all known Inquiry catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasResponses(AliasRequestList aliasRequests) Adds an Id to a Response for the purpose of creating compatibility.
CreateResponseList	createResponses(ResponseBatchFormList responseForms) Creates a new set of Responses.
DeleteResponseList	deleteAllResponses() Deletes all Responses in this Inquiry.
DeleteResponseList	deleteIneffectiveResponsesByDate(DateTime date) Deletes responses expired before the given date.
DeleteResponseList	deleteResponses(IdList responseIds) Deletes responses for the given Ids.
DeleteResponseList	deleteResponsesForInquiry(Id inquiryId) Deletes responses for the given Inquiry.
DeleteResponseList	deleteResponsesForResource(Id resourceId) Deletes responses for the given Resource.
ResponseBatchFormList	getResponseFormsForCreate(ResponsePeerList peers, Type[] responseRecordTypes) Gets the response forms for creating a bunch of new responses.
ResponseBatchFormList	getResponseFormsForUpdate(IdList responseIds) Gets the response forms for updating an existing set of responses.
UpdateResponseList	updateResponses(ResponseBatchFormList responseForms) Updates existing responses.

Methods inherited from interface org.osid.inquiry.ResponseAdminSession

aliasResponse, canCreateResponses, canCreateResponseWithRecordTypes, canDeleteResponses, canManageResponseAliases, canUpdateResponses, createResponse, deleteResponse, getInquest, getInquestId, getResponseFormForCreate, getResponseFormForUpdate, updateResponse

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

getResponseFormsForCreate

ResponseBatchFormList getResponseFormsForCreate(ResponsePeerList peers,
                                              Type[] responseRecordTypes)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Gets the response forms for creating a bunch of new responses. A form is retrieved for each inquiry and resource pair.

Parameters:

peers - list of inquiry resource peers

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

Returns:

the response forms

Throws:

NotFoundException - an inquiryId or resourceId is not found

NullArgumentException - peers or responseRecordTypes 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.

createResponses

CreateResponseList createResponses(ResponseBatchFormList responseForms)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

responseForms - the response forms

Returns:

the create responses

Throws:

NullArgumentException - responseForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getResponseFormsForUpdate

ResponseBatchFormList getResponseFormsForUpdate(IdList responseIds)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

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

Parameters:

responseIds - the Ids of the Response

Returns:

the response form

Throws:

NotFoundException - a responseId is not found

NullArgumentException - responseIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateResponses

UpdateResponseList updateResponses(ResponseBatchFormList responseForms)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

responseForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - responseForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllResponses

DeleteResponseList deleteAllResponses()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Deletes all Responses in this Inquiry.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteResponses

DeleteResponseList deleteResponses(IdList responseIds)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes responses for the given Ids.

Parameters:

responseIds - the Ids of the responses to delete

Returns:

the delete responses

Throws:

NullArgumentException - responseIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteResponsesForInquiry

DeleteResponseList deleteResponsesForInquiry(Id inquiryId)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Deletes responses for the given Inquiry.

Parameters:

inquiryId - an inquiry Id

Returns:

the delete responses

Throws:

NullArgumentException - inquiryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteResponsesForResource

DeleteResponseList deleteResponsesForResource(Id resourceId)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Deletes responses for the given Resource.

Parameters:

resourceId - a resource Id

Returns:

the delete responses

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveResponsesByDate

DeleteResponseList deleteIneffectiveResponsesByDate(DateTime date)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Deletes responses expired before the given date.

Parameters:

date - a date

Returns:

the delete responses

Throws:

NullArgumentException - date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasResponses

AliasResponseList aliasResponses(AliasRequestList aliasRequests)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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