| Interface | osid.inquiry.rules.AuditConstrainerSearchSession | ||
|---|---|---|---|
| Implements | osid.inquiry.rules.AuditConstrainerQuerySession | ||
| Used By | osid.inquiry.rules.InquiryRulesManager | ||
osid.inquiry.rules.InquiryRulesProxyManager | |||
| Description |
This session provides methods for searching among
getAuditConstrainersByQuery() is the basic search
method and returns a list of AuditConstrainers. A
more advanced search may be performed with
getAuditConstrainersBySearch(). It accepts an
AuditConstrainerSearch in addition to the query
for the purpose of specifying additional options affecting the
entire search, such as ordering.
getAuditConstrainersBySearch() returns an
AuditConstrainerSearchResults that can be used to
access the resulting AuditConstrainerList or be
used to perform a search within the result set through Au
ditConstrainerSearch.
This session defines views that offer differing behaviors for searching.
Audit constrainers may have a query record indicated by
their respective record types. The query record is accessed
via the | ||
| Method | getAuditConstrainerSearch | ||
| Description |
Gets an audit constrainer search. | ||
| Return | osid.inquiry.rules.AuditConstrainerSearch | the audit constrainer search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuditConstrainerSearchOrder | ||
| Description |
Gets an audit constrainer search order. The
| ||
| Return | osid.inquiry.rules.AuditConstrainerSearchOrder | the audit constrainer search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuditConstrainersBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.inquiry.rules.AuditConstrainerQuery | auditConstrainerQuery | the audit constrainer query |
osid.inquiry.rules.AuditConstrainerSearch | auditConstrainerSearch | the audit constrainer search | |
| Return | osid.inquiry.rules.AuditConstrainerSearchResults | the returned search results | |
| Errors | NULL_ARGUMENT | auditConstrainerQuery or auditConstrainerSearch
is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | auditConstrainerQuery or auditConstrainerSearch
is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAuditConstrainerQueryFromInspector | ||
| Description |
Gets an audit constrainer query from an inspector. The
inspector is available from an
| ||
| Parameters | osid.inquiry.rules.AuditConstrainerQueryInspector | auditConstrainerQueryInspector | an audit constrainer query inspector |
| Return | osid.inquiry.rules.AuditConstrainerQuery | the audit constrainer query | |
| Errors | NULL_ARGUMENT | auditConstrainerQueryInspector is null | |
| UNSUPPORTED | auditConstrainerQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |