| Interface | osid.repository.CompositionSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The interface for governing composition searches. | ||
| Method | searchAmongCompositions | ||
| Description |
Execute this search among the given list of compositions. | ||
| Parameters | osid.id.IdList | compositionIds | list of compositions |
| Errors | NULL_ARGUMENT | compositionIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderCompositionResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.repository.CompositionSearchOrder | compositionSearchOrder | composition search order |
| Errors | NULL_ARGUMENT | compositionSearchOrder is null | |
| UNSUPPORTED | compositionSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getCompositionSearchRecord | ||
| Description |
Gets the composition search record corresponding to the
given composition search record | ||
| Parameters | osid.type.Type | compositionSearchRecordType | a composition search record type |
| Return | osid.repository.records.CompositionSearchRecord | the composition search 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. | |