| Interface | osid.inquiry.rules.AuditProcessorEnablerSearchSession | ||
|---|---|---|---|
| Implements | osid.inquiry.rules.AuditProcessorEnablerQuerySession | ||
| Used By | osid.inquiry.rules.InquiryRulesManager | ||
osid.inquiry.rules.InquiryRulesProxyManager | |||
| Description |
This session provides methods for searching among
getAuditProcessorEnablersByQuery() is the basic
search method and returns a list of
AuditProcessorEnablers. A more advanced search
may be performed with
getAuditProcessorEnablersBySearch().It accepts an
AuditProcessorEnablerSearch in addition to the
query for the purpose of specifying additional options
affecting the entire search, such as ordering.
getAuditProcessorEnablersBySearch() returns an
AuditProcessorEnablerSearchResults that can be
used to access the resulting
AuditProcessorEnablerList or be used to perform a
search within the result set through Au
ditProcessorEnablerSearch.
This session defines views that offer differing behaviors for searching.
Audit processor enablers may have a query record indicated
by their respective record types. The query record is accessed
via the | ||
| Method | getAuditProcessorEnablerSearch | ||
| Description |
Gets an audit processor enabler search. | ||
| Return | osid.inquiry.rules.AuditProcessorEnablerSearch | the audit processor enabler search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuditProcessorEnablerSearchOrder | ||
| Description |
Gets an audit processor enabler search order. The
| ||
| Return | osid.inquiry.rules.AuditProcessorEnablerSearchOrder | the audit processor enabler search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuditProcessorEnablersBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.inquiry.rules.AuditProcessorEnablerQuery | auditProcessorEnablerQuery | the audit processor enabler query |
osid.inquiry.rules.AuditProcessorEnablerSearch | auditProcessorEnablerSearch | the audit processor enabler search | |
| Return | osid.inquiry.rules.AuditProcessorEnablerSearchResults | the returned search results | |
| Errors | NULL_ARGUMENT | auditProcessorEnablerQuery or
auditProcessorEnablerSearch is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | auditProcessorEnablerQuery or
auditProcessorEnablerSearch is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuditProcessorEnablerQueryFromInspector | ||
| Description |
Gets an audit processor enabler query from an
inspector. The inspector is available from an
| ||
| Parameters | osid.inquiry.rules.AuditProcessorEnablerQueryInspector | auditProcessorEnablerQueryInspector | an audit processor enabler query inspector |
| Return | osid.inquiry.rules.AuditProcessorEnablerQuery | the audit processor enabler query | |
| Errors | NULL_ARGUMENT | auditProcessorEnablerQueryInspector is null | |
| UNSUPPORTED | auditProcessorEnablerQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |