OSID Specifications
sequencing package
Version 3.0.0
sequencing package
Version 3.0.0
| Interface | osid.sequencing.AntimatroidSearchSession | ||
|---|---|---|---|
| Implements | osid.sequencing.AntimatroidQuerySession | ||
| Used By | osid.sequencing.SequencingManager | ||
osid.sequencing.SequencingProxyManager | |||
| Description |
This session provides methods for searching among
getAntimatroidsByQuery() is the basic search
method and returns a list of Antimatroids . A
more advanced search may be performed with
getAntimatroidsBySearch() .It accepts an
AntimatroidSearch in addition to the query for
the purpose of specifying additional options affecting the
entire search, such as ordering.
getAntimatroidsBySearch() returns an
AntimatroidSearchResults that can be used to
access the resulting AntimatroidList or be used
to perform a search within the result set through
AntimatroidSearch .
Antimatroids may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
| Method | getAntimatroidSearch | ||
| Description |
Gets an antimatroid search. | ||
| Return | osid.sequencing.AntimatroidSearch | the antimatroid search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAntimatroidSearchOrder | ||
| Description |
Gets an antimatroid search order. The
| ||
| Return | osid.sequencing.AntimatroidSearchOrder | the antimatroid search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAntimatroidsBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.sequencing.AntimatroidQuery | antimatroidQuery | the antimatroid query |
osid.sequencing.AntimatroidSearch | antimatroidSearch | the antimatroid search | |
| Return | osid.sequencing.AntimatroidSearchResults | the antimatroid search results | |
| Errors | NULL_ARGUMENT | antimatroidQuery or antimatroidSearch is
null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | antimatroidQuery or antimatroidSearch is not of
this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAntimatroidQueryFromInspector | ||
| Description |
Gets an antimatroid query from an inspector. The
inspector is available from an
| ||
| Parameters | osid.sequencing.AntimatroidQueryInspector | antimatroidQueryInspector | an antimatroid query inspector |
| Return | osid.sequencing.AntimatroidQuery | the antimatroid query | |
| Errors | NULL_ARGUMENT | antimatroidQueryInspector is null | |
| UNSUPPORTED | antimatroidQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |