Interface FunctionSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface FunctionSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
FunctionQueryInspector	getFunctionQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
FunctionList	getFunctions()	Gets the function list resulting from the search.
FunctionSearchResultsRecord	getFunctionSearchResultsRecord(Type functionSearchRecordType)	Gets the function search results record corresponding to the given function 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

getFunctions

FunctionList getFunctions()

Gets the function list resulting from the search.

Returns:

the function list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getFunctionQueryInspector

FunctionQueryInspector getFunctionQueryInspector()

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

Returns:

the function query inspector

Compliance:

mandatory - This method must be implemented.

getFunctionSearchResultsRecord

FunctionSearchResultsRecord getFunctionSearchResultsRecord(Type functionSearchRecordType)
                                                    throws OperationFailedException

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

Parameters:

functionSearchRecordType - a function search record type

Returns:

the function search results record

Throws:

NullArgumentException - functionSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(functionSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.