public interface InventorySearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
InventoryList |
getInventories()
Gets the inventory list resulting from a search.
|
InventoryQueryInspector |
getInventoryQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
InventorySearchResultsRecord |
getInventorySearchResultsRecord(Type inventorySearchRecordType)
Gets the inventory search results record corresponding to the given
inventory search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
InventoryList getInventories()
IllegalStateException
- the inventory list has already
been retrievedmandatory
- This method must be implemented. InventoryQueryInspector getInventoryQueryInspector()
mandatory
- This method must be implemented. InventorySearchResultsRecord getInventorySearchResultsRecord(Type inventorySearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.inventorySearchRecordType
- a inventory search record typeNullArgumentException
-
inventorySearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(inventorySearchRecordType)
is
false
mandatory
- This method must be implemented.