| Interface | osid.inquiry.rules.AuditEnablerSearchSession | ||
|---|---|---|---|
| Implements | osid.inquiry.rules.AuditEnablerQuerySession | ||
| Used By | osid.inquiry.rules.InquiryRulesManager | ||
osid.inquiry.rules.InquiryRulesProxyManager | |||
| Description |
This session provides methods for searching among
getAuditEnablersByQuery() is the basic search
method and returns a list of AuditEnablers. A
more advanced search may be performed with
getAuditEnablersBySearch().It accepts an
AuditEnablerSearch in addition to the query for
the purpose of specifying additional options affecting the
entire search, such as inquiry.
getAuditEnablersBySearch() returns an
AuditEnablerSearchResults that can be used to
access the resulting AuditEnablerList or be used
to perform a search within the result set through
AuditEnablerSearch.
This session defines views that offer differing behaviors for searching.
AuditEnablers may have a query record indicated
by their respective record types. The query record is accessed
via the AuditEnablerQuery. | ||
| Method | getAuditEnablerSearch | ||
| Description |
Gets an audit enabler search. | ||
| Return | osid.inquiry.rules.AuditEnablerSearch | the audit enabler search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuditEnablerSearchOrder | ||
| Description |
Gets an audit enabler search order. The
| ||
| Return | osid.inquiry.rules.AuditEnablerSearchOrder | the audit enabler search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuditEnablersBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.inquiry.rules.AuditEnablerQuery | auditEnablerQuery | the audit enabler query |
osid.inquiry.rules.AuditEnablerSearch | auditEnablerSearch | the audit enabler search | |
| Return | osid.inquiry.rules.AuditEnablerSearchResults | the returned search results | |
| Errors | NULL_ARGUMENT | auditEnablerQuery or auditEnablerSearch is
null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | auditEnablerQuery or auditEnablerSearch is not
of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuditEnablerQueryFromInspector | ||
| Description |
Gets an audit enabler query from an inspector. The
inspector is available from an
| ||
| Parameters | osid.inquiry.rules.AuditEnablerQueryInspector | auditEnablerQueryInspector | an audit enabler query inspector |
| Return | osid.inquiry.rules.AuditEnablerQuery | the audit enabler query | |
| Errors | NULL_ARGUMENT | auditEnablerQueryInspector is null | |
| UNSUPPORTED | auditEnablerQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |