| Interface | osid.hold.rules.IssueEnablerSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.hold.rules.IssueEnablerSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getIssueEnablers | ||
| Description |
Gets the issue enabler list resulting from a search. | ||
| Return | osid.hold.rules.IssueEnablerList | the issu eenabler list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIssueEnablerQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.hold.rules.IssueEnablerQueryInspector | the issue enabler query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIssueEnablerSearchResultsRecord | ||
| Description |
Gets the issue enabler search results record
corresponding to the given issue enabler search record
| ||
| Parameters | osid.type.Type | issueEnablerSearchRecordType | an issue enabler search record type |
| Return | osid.hold.rules.records.IssueEnablerSearchResultsRecord | the issue enabler search results record | |
| Errors | NULL_ARGUMENT | issueEnablerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(issueEnablerSearchRecordTypee) is
false | ||
| Compliance | mandatory | This method must be implemented. | |