Interface ItemSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ItemSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	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 the search.
ItemSearchResultsRecord	getItemSearchResultsRecord(Type itemSearchRecordType)	Gets the record corresponding to the given item search record Type .

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

getItems

ItemList getItems()

Gets the item list resulting from the search.

Returns:

the item list

Throws:

IllegalStateException - the item list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getItemQueryInspector

ItemQueryInspector getItemQueryInspector()

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.

getItemSearchResultsRecord

ItemSearchResultsRecord getItemSearchResultsRecord(Type itemSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

itemSearchRecordType - an item search record type

Returns:

the item search results record

Throws:

NullArgumentException - itemSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(itemSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.