Interface InputSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface InputSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
InputQueryInspector	getInputQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
InputList	getInputs()	Gets the input list resulting from a search.
InputSearchResultsRecord	getInputSearchResultsRecord(Type inputSearchRecordType)	Gets the input search results record corresponding to the given input 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

getInputs

InputList getInputs()

Gets the input list resulting from a search.

Returns:

the input list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getInputQueryInspector

InputQueryInspector getInputQueryInspector()

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

Returns:

the input query inspector

Compliance:

mandatory - This method must be implemented.

getInputSearchResultsRecord

InputSearchResultsRecord getInputSearchResultsRecord(Type inputSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

inputSearchRecordType - an input search record type

Returns:

the input search results record

Throws:

NullArgumentException - inputSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inputSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.