Interface ParameterProcessorSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ParameterProcessorSearch
extends OsidSearch

The search interface for governing parameter processor searches.

Method Summary

Modifier and Type	Method	Description
ParameterProcessorSearchRecord	getParameterProcessorSearchRecord(Type parameterProcessorSearchRecordType)	Gets the parameter processor search record corresponding to the given parameter processor search record Type.
void	orderParameterProcessorResults(ParameterProcessorSearchOrder parameterProcessorSearchOrder)	Specify an ordering to the search results.
void	searchAmongParameterProcessors(IdList parameterProcessorIds)	Execute this search among the given list of parameter processors.

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

searchAmongParameterProcessors

void searchAmongParameterProcessors(IdList parameterProcessorIds)

Execute this search among the given list of parameter processors.

Parameters:

parameterProcessorIds - list of parameter processors

Throws:

NullArgumentException - parameterProcessorIds is null

Compliance:

mandatory - This method must be implemented.

orderParameterProcessorResults

void orderParameterProcessorResults(ParameterProcessorSearchOrder parameterProcessorSearchOrder)

Specify an ordering to the search results.

Parameters:

parameterProcessorSearchOrder - parameter processor search order

Throws:

NullArgumentException - parameterProcessorSearchOrder is null

UnsupportedException - parameterProcessorSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getParameterProcessorSearchRecord

ParameterProcessorSearchRecord getParameterProcessorSearchRecord(Type parameterProcessorSearchRecordType)
                                                          throws OperationFailedException

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

Parameters:

parameterProcessorSearchRecordType - a parameter processor search record type

Returns:

the parameter processor search record

Throws:

NullArgumentException - parameterProcessorSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(parameterProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.