Interface | osid.inquiry.batch.ResponseBatchAdminSession | ||
---|---|---|---|
Implements | osid.inquiry.ResponseAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getResponseFormsForCreate | ||
Description |
Gets the response forms for creating a bunch of new responses. A form is retrieved for each inquiry and resource pair. | ||
Parameters | osid.inquiry.batch.ResponsePeerList | peers | list of inquiry resource peers |
osid.type.Type[] | responseRecordTypes | array of response record types to be included in each create operation or an empty list if none | |
Return | osid.inquiry.batch.ResponseBatchFormList | the response forms | |
Errors | NOT_FOUND | an inquiryId or resourceId is not found | |
NULL_ARGUMENT | peers or responseRecordTypes is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createResponses | ||
Description |
Creates a new set of | ||
Parameters | osid.inquiry.batch.ResponseBatchFormList | responseForms | the response forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | responseForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getResponseFormsForUpdate | ||
Description |
Gets the response forms for updating an existing set of responses. A new response form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | responseIds | the Ids of the Response |
Return | osid.inquiry.batch.ResponseBatchFormList | the response form | |
Errors | NOT_FOUND | a responseId is not found | |
NULL_ARGUMENT | responseIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateResponses | ||
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
| ||
Parameters | osid.inquiry.batch.ResponseBatchFormList | responseForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | responseForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllResponses | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteResponses | ||
Description |
Deletes responses for the given | ||
Parameters | osid.id.IdList | responseIds | the Ids of the responses to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | responseIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteResponsesForInquiry | ||
Description |
Deletes responses for the given | ||
Parameters | osid.id.Id | inquiryId | an inquiry Id |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | inquiryId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteResponsesForResource | ||
Description |
Deletes responses for the given | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIneffectiveResponsesByDate | ||
Description |
Deletes responses expired before the given date. | ||
Parameters | osid.calendaring.DateTime | date | a date |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | date is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasResponses | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |