Interface | osid.inquiry.AuditQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Audits may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
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 | canSearchAudits | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedInquestView | ||
Description |
Federates the view for methods in this session. A federated view will include audits in inquests which are children of this action group in the inquest hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedInquestView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this inquest only. | ||
Compliance | mandatory | This method is 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 | getAuditsByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.inquiry.AuditQuery | auditQuery | the audit query |
Return | osid.inquiry.AuditList | the returned AuditList | |
Errors | NULL_ARGUMENT | auditQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | auditQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |