| Interface | osid.inquiry.AuditSmartInquestSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. An This | ||
| Method | getInquestId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the Inquest Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInquest | ||
| Description |
Gets the | ||
| Return | osid.inquiry.Inquest | the inquest | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canManageSmartInquests | ||
| Description |
Tests if this user can manage smart inquests. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known methods in this
session will result in a | ||
| Return | boolean | false if smart inquest management is not authorized,
true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuditQuery | ||
| Description |
Gets an audit query. | ||
| Return | osid.inquiry.AuditQuery | the audit query | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuditSearchOrder | ||
| Description |
Gets an audit search order. | ||
| Return | osid.inquiry.AuditSearchOrder | the audit search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | applyAuditQuery | ||
| Description |
Applies an audit query to this inquest. | ||
| Parameters | osid.inquiry.AuditQuery | auditQuery | the audit query |
| Errors | NULL_ARGUMENT | auditQuery is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | auditQuery not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | inspecAuditQuery | ||
| Description |
Gets an audit query inspector for this inquest. | ||
| Return | osid.inquiry.AuditQueryInspector | the audit query inspector | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure occurred | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | applyAuditSequencing | ||
| Description |
Applies an audit search order to this inquest. | ||
| Parameters | osid.inquiry.AuditSearchOrder | auditSearchOrder | the audit search order |
| Errors | NULL_ARGUMENT | auditSearchOrder is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | auditSearchOrder not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuditQueryFromInspector | ||
| Description |
Gets an audit query from an inspector. | ||
| Parameters | osid.inquiry.AuditQueryInspector | auditQueryInspector | an audit query inspector |
| Return | osid.inquiry.AuditQuery | the audit query | |
| Errors | NULL_ARGUMENT | auditQueryInspector is null | |
| UNSUPPORTED | auditQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |