Interface StateSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface StateSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
StateQueryInspector	getStateQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
StateList	getStates()	Gets the state list resulting from a search.
StateSearchResultsRecord	getStateSearchResultsRecord(Type stateSearchRecordType)	Gets the state search results record corresponding to the given state 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

getStates

StateList getStates()

Gets the state list resulting from a search.

Returns:

the state list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getStateQueryInspector

StateQueryInspector getStateQueryInspector()

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

Returns:

the state query inspector

Compliance:

mandatory - This method must be implemented.

getStateSearchResultsRecord

StateSearchResultsRecord getStateSearchResultsRecord(Type stateSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

stateSearchRecordType - a state search record type

Returns:

the state search results record

Throws:

NullArgumentException - stateSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordTypeType(stateSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.