public interface CompositionSearch extends OsidSearch
The interface for governing composition searches.
Modifier and Type | Method and Description |
---|---|
CompositionSearchRecord |
getCompositionSearchRecord(Type compositionSearchRecordType)
Gets the composition search record corresponding to the given
composition search record
Type. |
void |
orderCompositionResults(CompositionSearchOrder compositionSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongCompositions(IdList compositionIds)
Execute this search among the given list of compositions.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongCompositions(IdList compositionIds)
compositionIds
- list of compositionsNullArgumentException
- compositionIds
is null
mandatory
- This method must be implemented. void orderCompositionResults(CompositionSearchOrder compositionSearchOrder)
compositionSearchOrder
- composition search orderNullArgumentException
- compositionSearchOrder
is null
UnsupportedException
- compositionSearchOrder
is not of this servicemandatory
- This method must be implemented. CompositionSearchRecord getCompositionSearchRecord(Type compositionSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.compositionSearchRecordType
- a composition search record typeNullArgumentException
-
compositionSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(compositionSearchRecordType)
is
false
mandatory
- This method must be implemented.