public interface ItemSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
ItemQueryInspector |
getItemQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
ItemList |
getItems()
Gets the item list resulting from a search.
|
ItemSearchResultsRecord |
getItemSearchResultsRecord(Type itemSearchRecordType)
Gets the item search results record corresponding to the given item
search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
ItemList getItems()
IllegalStateException
- the item list has already been
retrievedmandatory
- This method must be implemented. ItemQueryInspector getItemQueryInspector()
mandatory
- This method must be implemented. ItemSearchResultsRecord getItemSearchResultsRecord(Type itemSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.itemSearchRecordType
- a item search record typeNullArgumentException
- itemSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(itemSearchRecordType)
is false
mandatory
- This method must be implemented.