| Interface | osid.inquiry.rules.AuditConstrainerEnablerQuerySession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Implemented By | osid.inquiry.rules.AuditConstrainerEnablerSearchSession | ||
| Used By | osid.inquiry.rules.InquiryRulesManager | ||
osid.inquiry.rules.InquiryRulesProxyManager | |||
| Description |
This session provides methods for searching among
This session defines views that offer differing behaviors for searching.
Audit constrainer enablers 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 | canSearchAuditConstrainerEnablers | ||
| 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 audit constrainer enablers in inquests which are children of this inquest 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 searches to this inquest only. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | getAuditConstrainerEnablerQuery | ||
| Description |
Gets an audit constrainer enabler query. | ||
| Return | osid.inquiry.rules.AuditConstrainerEnablerQuery | the audit constrainer enabler query | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuditConstrainerEnablersByQuery | ||
| Description |
Gets a list of | ||
| Parameters | osid.inquiry.rules.AuditConstrainerEnablerQuery | auditConstrainerEnablerQuery | the audit constrainer enabler query |
| Return | osid.inquiry.rules.AuditConstrainerEnablerList | the returned AuditConstrainerEnablerList | |
| Errors | NULL_ARGUMENT | auditConstrainerEnablerQuery is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | auditConstrainerEnablerQuery did not originate from
getAuditConstrainerEnablerQuery() | ||
| Compliance | mandatory | This method must be implemented. | |