OSID Specifications
sequencing package
Version 3.0.0
Release Candidate Preview
sequencing package
Version 3.0.0
Release Candidate Preview
| Interface | osid.sequencing.AntimatroidSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getAntimatroids | ||
| Description |
Gets the antimatroid list resulting from a search. | ||
| Return | osid.sequencing.AntimatroidList | the antimatroid list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAntimatroidQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.sequencing.AntimatroidQueryInspector | the antimatroid query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAntimatroidSearchResultsRecord | ||
| Description |
Gets the antimatroid search results record
corresponding to the given antimatroid search record
| ||
| Parameters | osid.type.Type | antimatroidSearchRecordType | an antimatroid search record type |
| Return | osid.sequencing.records.AntimatroidSearchResultsRecord | the antimatroid search results record | |
| Errors | NULL_ARGUMENT | antimatroidSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(antimatroidSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |