| Interface | osid.inquiry.rules.AuditConstrainerEnablerSearchSession | ||
|---|---|---|---|
| Implements | osid.inquiry.rules.AuditConstrainerEnablerQuerySession | ||
| Used By | osid.inquiry.rules.InquiryRulesManager | ||
osid.inquiry.rules.InquiryRulesProxyManager | |||
| Description |
This session provides methods for searching among
getAuditConstrainerEnablersByQuery() is the basic
search method and returns a list of
AuditConstrainerEnablers. A more advanced search
may be performed with
getAuditConstrainerEnablersBySearch().It accepts
an AuditConstrainerEnablerSearch in addition to
the query for the purpose of specifying additional options
affecting the entire search, such as ordering.
getAuditConstrainerEnablersBySearch() returns an
AuditConstrainerEnablerSearchResults that can be
used to access the resulting
AuditConstrainerEnablerList or be used to perform
a search within the result set through
AuditConstrainerEnablerSearch.
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 | getAuditConstrainerEnablerSearch | ||
| Description |
Gets an audit constrainer enabler search. | ||
| Return | osid.inquiry.rules.AuditConstrainerEnablerSearch | the audit constrainer enabler search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuditConstrainerEnablerSearchOrder | ||
| Description |
Gets an audit constrainer enabler search order. The
| ||
| Return | osid.inquiry.rules.AuditConstrainerEnablerSearchOrder | the audit constrainer enabler search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuditConstrainerEnablersBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.inquiry.rules.AuditEnablerQuery | auditConstrainerEnablerQuery | the audit constrainer enabler query |
osid.inquiry.rules.AuditConstrainerEnablerSearch | auditConstrainerEnablerSearch | the audit constrainer enabler search | |
| Return | osid.inquiry.rules.AuditConstrainerEnablerSearchResults | the returned search results | |
| Errors | NULL_ARGUMENT | auditConstrainerEnablerQuery or
auditConstrainerEnablerSearch is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | auditConstrainerEnablerQuery or
auditConstrainerEnablerSearch is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuditConstrainerEnablerQueryFromInspector | ||
| Description |
Gets an audit constrainer enabler query from an
inspector. The inspector is available from an
| ||
| Parameters | osid.inquiry.rules.AuditConstrainerEnablerQueryInspector | auditConstrainerEnablerQueryInspector | an audit constrainer enabler query inspector |
| Return | osid.inquiry.rules.AuditConstrainerEnablerQuery | the audit constrainer enabler query | |
| Errors | NULL_ARGUMENT | auditConstrainerEnablerQueryInspector is null | |
| UNSUPPORTED | auditConstrainerEnablerQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |