| Interface | osid.hold.rules.IssueConstrainerSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.hold.rules.IssueConstrainerSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getIssueConstrainers | ||
| Description |
Gets the issue constrainer list resulting from a search. | ||
| Return | osid.hold.rules.IssueConstrainerList | the issue constrainer list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIssueConstrainerQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.hold.rules.IssueConstrainerQueryInspector | the issue constrainer query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIssueConstrainerSearchResultsRecord | ||
| Description |
Gets the issue constrainer search results record
corresponding to the given issue constrainer search record
| ||
| Parameters | osid.type.Type | issueConstrainerSearchRecordType | an issue constrainer search record type |
| Return | osid.hold.rules.records.IssueConstrainerSearchResultsRecord | the issue constrainer search results record | |
| Errors | NULL_ARGUMENT | issueConstrainerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(issueConstrainerSearchRecordTypee) is
false | ||
| Compliance | mandatory | This method must be implemented. | |