org.osid.inventory

Interface InventorySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface InventorySearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getInventories

InventoryList getInventories()

Gets the inventory list resulting from a search.

Returns:

the inventory list

Throws:

IllegalStateException - the inventory list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getInventoryQueryInspector

InventoryQueryInspector getInventoryQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getInventorySearchResultsRecord

InventorySearchResultsRecord getInventorySearchResultsRecord(Type inventorySearchRecordType)
                                                             throws OperationFailedException

Gets the inventory search results record corresponding to the given inventory search record Type. This method is used to retrieve an object implementing the requested record.

Parameters:

inventorySearchRecordType - a inventory search record type

Returns:

the inventory search interface

Throws:

NullArgumentException - inventorySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inventorySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.