OSID Specifications
sequencing package
Version 3.0.0
Release Candidate Preview
sequencing package
Version 3.0.0
Release Candidate Preview
| Interface | osid.sequencing.ChainSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing chain searches. | ||
| Method | searchAmongChains | ||
| Description |
Execute this search among the given list of chains. | ||
| Parameters | osid.id.IdList | chainIds | list of chains |
| Errors | NULL_ARGUMENT | chainIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderChainResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.sequencing.ChainSearchOrder | chainSearchOrder | chain search order |
| Errors | NULL_ARGUMENT | chainSearchOrder is null | |
| UNSUPPORTED | chainSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getChainSearchRecord | ||
| Description |
Gets the chain search record corresponding to the given
chain search record | ||
| Parameters | osid.type.Type | chainSearchRecordType | a chain search record type |
| Return | osid.sequencing.records.ChainSearchRecord | the chain search interface | |
| Errors | NULL_ARGUMENT | chainSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(chainSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |