Interface | osid.repository.CompositionSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getCompositions | ||
Description |
Gets the composition list resulting from a search. | ||
Return | osid.repository.CompositionList | the composition list | |
Errors | ILLEGAL_STATE | the list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getCompositionQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.repository.CompositionQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getCompositionSearchResultsRecord | ||
Description |
Gets the composition search results record
corresponding to the given composition search record
| ||
Parameters | osid.type.Type | compositionSearchRecordType | a composition search record type |
Return | osid.repository.records.CompositionSearchResultsRecord | the composition search results record | |
Errors | NULL_ARGUMENT | compositionSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(compositionSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |