Interface WarehouseSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface WarehouseSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
WarehouseQueryInspector	getWarehouseQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
WarehouseList	getWarehouses()	Gets the warehouse list resulting from a search.
WarehouseSearchResultsRecord	getWarehouseSearchResultsRecord(Type warehouseSearchRecordType)	Gets the warehouse search results record corresponding to the given warehouse search record Type .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getWarehouses

WarehouseList getWarehouses()

Gets the warehouse list resulting from a search.

Returns:

the warehouse list

Throws:

IllegalStateException - the warehouse list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getWarehouseQueryInspector

WarehouseQueryInspector getWarehouseQueryInspector()

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.

getWarehouseSearchResultsRecord

WarehouseSearchResultsRecord getWarehouseSearchResultsRecord(Type warehouseSearchRecordType)
                                                      throws OperationFailedException

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

Parameters:

warehouseSearchRecordType - a warehouse search record type

Returns:

the warehouse search results record

Throws:

NullArgumentException - warehousesearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(warehouseSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.