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.
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.
|
aliasResponse, canCreateResponses, canCreateResponseWithRecordTypes, canDeleteResponses, canManageResponseAliases, canUpdateResponses, createResponse, deleteResponse, getInquest, getInquestId, getResponseFormForCreate, getResponseFormForUpdate, updateResponse
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ResponseBatchFormList getResponseFormsForCreate(ResponsePeerList peers, Type[] responseRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
peers
- list of inquiry resource peersresponseRecordTypes
- array of response record types to be
included in each create operation or an empty list if noneNotFoundException
- an inquiryId
or
resourceId
is not foundNullArgumentException
- peers
or
responseRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createResponses(ResponseBatchFormList responseForms) throws OperationFailedException, PermissionDeniedException
Responses.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.responseForms
- the response formsNullArgumentException
- responseForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResponseBatchFormList getResponseFormsForUpdate(IdList responseIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
responseIds
- the Ids
of the Response
NotFoundException
- a responseId
is not
foundNullArgumentException
- responseIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateResponses(ResponseBatchFormList responseForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.responseForms
- the form containing the elements to be updatedNullArgumentException
- responseForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllResponses() throws OperationFailedException, PermissionDeniedException
Responses
in this Inquiry.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteResponses(IdList responseIds) throws OperationFailedException, PermissionDeniedException
Ids.
responseIds
- the Ids
of the responses to deleteNullArgumentException
- responseIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteResponsesForInquiry(Id inquiryId) throws OperationFailedException, PermissionDeniedException
Inquiry.
inquiryId
- an inquiry Id
NullArgumentException
- inquiryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteResponsesForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
Resource.
resourceId
- a resource Id
NullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteIneffectiveResponsesByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
date
- a dateNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasResponses(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.