Interface ValueSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ValueSearch
extends OsidSearch

The interface for governing value searches.

Method Summary

Modifier and Type	Method	Description
ValueSearchRecord	getValueSearchRecord(Type valueSearchRecordType)	Gets the value search record corresponding to the given value search record Type.
void	orderValueResults(ValueSearchOrder valueSearchOrder)	Specify an ordering to the search results.
void	searchAmongValues(IdList valueIds)	Executes this search among a given list of values.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongValues

void searchAmongValues(IdList valueIds)

Executes this search among a given list of values.

Parameters:

valueIds - list of values

Throws:

NullArgumentException - valueIds is null

Compliance:

mandatory - This method must be implemented.

orderValueResults

void orderValueResults(ValueSearchOrder valueSearchOrder)

Specify an ordering to the search results.

Parameters:

valueSearchOrder - value search order

Throws:

NullArgumentException - valueSearchOrder is null

UnsupportedException - valueSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getValueSearchRecord

ValueSearchRecord getValueSearchRecord(Type valueSearchRecordType)
                                throws OperationFailedException

Gets the value search 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 record

Throws:

NullArgumentException - valueSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(valueSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.