Interface | osid.inquiry.batch.InquiryBatchAdminSession | ||
---|---|---|---|
Implements | osid.inquiry.InquiryAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getInquiryFormsForCreate | ||
Description |
Gets the inquiry forms for creating a bunch of new inquiries. An inquiry form is returned for each audit. | ||
Parameters | osid.id.IdList | auditIds | a list of audit Ids |
osid.type.Type[] | inquiryRecordTypes | array of inquiry record types to be included in each create operation or an empty list if none | |
Return | osid.inquiry.batch.InquiryBatchFormList | the inquiry forms | |
Errors | NOT_FOUND | an auditId is not found | |
NULL_ARGUMENT | auditIds or inquiryRecordTypes 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 | createInquiries | ||
Description |
Creates a new set of | ||
Parameters | osid.inquiry.batch.InquiryBatchFormList | inquiryForms | the inquiry forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | inquiryForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getInquiryFormsForUpdate | ||
Description |
Gets the inquiry forms for updating an existing set of inquiries. A new inquiry form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | inquiryIds | the Ids of the Inquiries |
Return | osid.inquiry.batch.InquiryBatchFormList | the inquiry forms | |
Errors | NOT_FOUND | an inquiryId is not found | |
NULL_ARGUMENT | inquiryIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateInquiries | ||
Description |
Updates existing inquiries. 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.InquiryBatchFormList | inquiryForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | inquiryForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllInquiries | ||
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 | deleteInquiries | ||
Description |
Deletes inquiries for the given | ||
Parameters | osid.id.IdList | inquiryIds | the Ids of the inquiries to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | inquiryIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteInquiriesForAudit | ||
Description |
Deletes inquiries for the given audit. | ||
Parameters | osid.id.Id | auditId | the Id of an audit |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | auditId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasInquiries | ||
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. |