OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
hold package
Version 3.0.0
Release Candidate Preview
| Interface | osid.hold.IssueSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing issue searches. | ||
| Method | searchAmongIssues | ||
| Description |
Execute this search among the given list of issues. | ||
| Parameters | osid.id.IdList | issueIds | list of issues |
| Errors | NULL_ARGUMENT | issueIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderIssueResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.hold.IssueSearchOrder | issueSearchOrder | issue search order |
| Errors | NULL_ARGUMENT | issueSearchOrder is null | |
| UNSUPPORTED | issueSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getIssueSearchRecord | ||
| Description |
Gets the issue search record corresponding to the given
issue search record | ||
| Parameters | osid.type.Type | issueSearchRecordType | an issue search record type |
| Return | osid.hold.records.IssueSearchRecord | the issue search 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. | |