public interface BinSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
BinQueryInspector |
getBinQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
BinList |
getBins()
Gets the bin list resulting from the search.
|
BinSearchResultsRecord |
getBinSearchResultsRecord(Type binSearchRecordType)
Gets the bin search results record corresponding to the given bin
search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
BinList getBins()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. BinQueryInspector getBinQueryInspector()
mandatory
- This method must be implemented. BinSearchResultsRecord getBinSearchResultsRecord(Type binSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.binSearchRecordType
- a bin search record typeNullArgumentException
- binSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(binSearchRecordType)
is false
mandatory
- This method must be implemented.