OSID Logo
OSID Specifications
inquiry batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.batch.ResponseBatchAdminSession
Implementsosid.inquiry.ResponseAdminSession
Description

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.

MethodgetResponseFormsForCreate
Description

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

Parametersosid.inquiry.batch.ResponsePeerListpeerslist of inquiry resource peers
osid.type.Type[]responseRecordTypesarray of response record types to be included in each create operation or an empty list if none
Returnosid.inquiry.batch.ResponseBatchFormListthe response forms
ErrorsNOT_FOUNDan inquiryId or resourceId is not found
NULL_ARGUMENT peers or responseRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateResponses
Description

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 .

Parametersosid.inquiry.batch.ResponseBatchFormListresponseFormsthe response forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT responseForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetResponseFormsForUpdate
Description

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

Parametersosid.id.IdListresponseIdsthe Ids of the Response
Returnosid.inquiry.batch.ResponseBatchFormListthe response form
ErrorsNOT_FOUNDa responseId is not found
NULL_ARGUMENT responseIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateResponses
Description

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 .

Parametersosid.inquiry.batch.ResponseBatchFormListresponseFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT responseForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllResponses
Description

Deletes all Responses in this Inquiry.

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

Deletes responses for the given Ids.

Parametersosid.id.IdListresponseIdsthe Ids of the responses to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT responseIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteResponsesForInquiry
Description

Deletes responses for the given Inquiry.

Parametersosid.id.IdinquiryIdan inquiry Id
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT inquiryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteResponsesForResource
Description

Deletes responses for the given Resource.

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

Deletes responses 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.
MethodaliasResponses
Description

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.

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.