org.osid.ordering

Interface StoreSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface StoreSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
StoreQueryInspector	getStoreQueryInspector() Gets the inspector for the query to examine the terns used in the search.
StoreList	getStores() Gets the store list resulting from a search.
StoreSearchResultsRecord	getStoreSearchResultsRecord(Type storeSearchRecordType) Gets the store search results record corresponding to the given store 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

getStores

StoreList getStores()

Gets the store list resulting from a search.

Returns:

the store list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getStoreQueryInspector

StoreQueryInspector getStoreQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getStoreSearchResultsRecord

StoreSearchResultsRecord getStoreSearchResultsRecord(Type storeSearchRecordType)
                                                     throws OperationFailedException

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

Parameters:

storeSearchRecordType - a store search record type

Returns:

the store search results record

Throws:

NullArgumentException - storeSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(storeSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.