Interface | osid.hold.IssueSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getIssues | ||
Description |
Gets the issue list resulting from a search. | ||
Return | osid.hold.IssueList | the issue list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getIssueQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.hold.IssueQueryInspector | the issue query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getIssueSearchResultsRecord | ||
Description |
Gets the issue search results record corresponding to
the given issue search record | ||
Parameters | osid.type.Type | issueSearchRecordType | an issue search record type |
Return | osid.hold.records.IssueSearchResultsRecord | the issue search results record | |
Errors | NULL_ARGUMENT | issueSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | hasRecordType(issueSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |