public interface CompositionSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
CompositionQueryInspector |
getCompositionQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
CompositionList |
getCompositions()
Gets the composition list resulting from a search.
|
CompositionSearchResultsRecord |
getCompositionSearchResultsRecord(Type compositionSearchRecordType)
Gets the composition search results record corresponding to the given
composition search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
CompositionList getCompositions()
IllegalStateException
- the list has already been
retrievedmandatory
- This method must be implemented. CompositionQueryInspector getCompositionQueryInspector()
mandatory
- This method must be implemented. CompositionSearchResultsRecord getCompositionSearchResultsRecord(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.