| Interface | osid.inquiry.batch.InquiryBatchManager | ||
|---|---|---|---|
| Implements | osid.OsidManager | ||
osid.inquiry.batch.InquiryBatchProfile | |||
| Description |
The inquiry batch manager provides access to inquiry batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
| Method | getInquiryBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.inquiry.batch.InquiryBatchAdminSession | an InquiryBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsInquiryBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsInquiryBatchAdmin()
is true. | |
| Method | getInquiryBatchAdminSessionForInquest | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | inquestId | the Id of the Inquest |
| Return | osid.inquiry.batch.InquiryBatchAdminSession | an InquiryBatchAdminSession | |
| Errors | NOT_FOUND | no Inquest found by the given Id | |
| NULL_ARGUMENT | inquestId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsInquiryBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsInquiryBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getAuditBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.inquiry.batch.AuditBatchAdminSession | an AuditBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsAuditBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsAuditBatchAdmin()
is true. | |
| Method | getAuditBatchAdminSessionForInquest | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | inquestId | the Id of the Inquest |
| Return | osid.inquiry.batch.AuditBatchAdminSession | an AuditBatchAdminSession | |
| Errors | NOT_FOUND | no Inquest found by the given Id | |
| NULL_ARGUMENT | inquestId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAuditBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsAuditBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getResponseAdminSession | ||
| Description |
Gets the | ||
| Return | osid.inquiry.batch.ResponseBatchAdminSession | a ResponseBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsResponseBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsResponseBatchAdmin()
is true. | |
| Method | getResponseAdminSessionForInquest | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | inquestId | the Id of the Inquest |
| Return | osid.inquiry.batch.ResponseBatchAdminSession | a ResponseBatchAdminSession | |
| Errors | NOT_FOUND | no Inquest found by the given Id | |
| NULL_ARGUMENT | inquestId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsResponseBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsResponseBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getInquestBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.inquiry.batch.InquestBatchAdminSession | a InquestBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsInquestBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsInquestBatchAdmin()
is true. | |