Interface ResponseSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ResponseSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ResponseQueryInspector	getResponseQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ResponseList	getResponses()	Gets the response list resulting from a search.
ResponseSearchResultsRecord	getResponseSearchResultsRecord(Type responseSearchRecordType)	Gets the response search results record corresponding to the given response 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

getResponses

ResponseList getResponses()

Gets the response list resulting from a search.

Returns:

the response list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getResponseQueryInspector

ResponseQueryInspector getResponseQueryInspector()

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

Returns:

the response query inspector

Compliance:

mandatory - This method must be implemented.

getResponseSearchResultsRecord

ResponseSearchResultsRecord getResponseSearchResultsRecord(Type responseSearchRecordType)
                                                    throws OperationFailedException

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

Parameters:

responseSearchRecordType - a response search record type

Returns:

the response search results record

Throws:

NullArgumentException - responseSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(responseSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.