Interface | osid.sequencing.ChainSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getChains | ||
Description |
Gets the chain list resulting from a search. | ||
Return | osid.sequencing.ChainList | the chain list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getChainQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.sequencing.ChainQueryInspector | the chain query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getChainSearchResultsRecord | ||
Description |
Gets the chain search results record corresponding to
the given chain search record | ||
Parameters | osid.type.Type | chainSearchRecordType | a chain search record type |
Return | osid.sequencing.records.ChainSearchResultsRecord | the chain search results record | |
Errors | NULL_ARGUMENT | chainSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(chainSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |