Interface ParameterSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ParameterSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ParameterQueryInspector	getParameterQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ParameterList	getParameters()	Gets the parameter list resulting from a search.
ParameterSearchResultsRecord	getParameterSearchResultsRecord(Type parameterSearchRecordType)	Gets the parameter search results record corresponding to the given parameter 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

getParameters

ParameterList getParameters()

Gets the parameter list resulting from a search.

Returns:

the parameter list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getParameterQueryInspector

ParameterQueryInspector getParameterQueryInspector()

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

Returns:

the parameter query inspector

Compliance:

mandatory - This method must be implemented.

getParameterSearchResultsRecord

ParameterSearchResultsRecord getParameterSearchResultsRecord(Type parameterSearchRecordType)
                                                      throws OperationFailedException

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

Parameters:

parameterSearchRecordType - a parameter search record type

Returns:

the parameter search results record

Throws:

NullArgumentException - parameterSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(parameterSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.