org.osid.configuration

Interface ValueSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ValueSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
ValueQueryInspector	getValueQueryInspector() Gets the inspector for the query to examine the terms used in the search.
ValueList	getValues() Gets the vakue list resulting from a search.
ValueSearchResultsRecord	getValueSearchResultsRecord(Type valueSearchRecordType) Gets the value search results record corresponding to the given value search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getValues

ValueList getValues()

Gets the vakue list resulting from a search.

Returns:

the value list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getValueQueryInspector

ValueQueryInspector getValueQueryInspector()

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

Returns:

the value query inspector

Compliance:

mandatory - This method must be implemented.

getValueSearchResultsRecord

ValueSearchResultsRecord getValueSearchResultsRecord(Type valueSearchRecordType)
                                                     throws OperationFailedException

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

Parameters:

valueSearchRecordType - a value search record type

Returns:

the value search results record

Throws:

NullArgumentException - valueSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(valueSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.