Interface ParameterSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ParameterSearch
extends OsidSearch

ParameterSearch specifies the interface for specifying parameter search options.

Method Summary

Modifier and Type	Method	Description
ParameterSearchRecord	getParameterSearchRecord(Type parameterSearchRecordType)	Gets the parameter search record corresponding to the given parameter search record Type .
void	orderParameterResults(ParameterSearchOrder parameterSearchOrder)	Specify an ordering to the search results.
void	searchAmongParameters(IdList parameterIds)	Executes this search among a given list of parameters.

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

searchAmongParameters

void searchAmongParameters(IdList parameterIds)

Executes this search among a given list of parameters.

Parameters:

parameterIds - list of parameters

Throws:

NullArgumentException - parameterIds is null

Compliance:

mandatory - This method must be implemented.

orderParameterResults

void orderParameterResults(ParameterSearchOrder parameterSearchOrder)

Specify an ordering to the search results.

Parameters:

parameterSearchOrder - parameter search order

Throws:

NullArgumentException - parameterSearchOrder is null

UnsupportedException - parameterSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getParameterSearchRecord

ParameterSearchRecord getParameterSearchRecord(Type parameterSearchRecordType)
                                        throws OperationFailedException

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

Throws:

NullArgumentException - parameterRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(parameterSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.