Interface FunctionSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface FunctionSearch
extends OsidSearch

FunctionSearch defines the interface for specifying function search options.

Method Summary

Modifier and Type	Method	Description
FunctionSearchRecord	getFunctionSearchRecord(Type functionSearchRecordType)	Gets the function search record corresponding to the given function search record Type.
void	orderFunctionResults(FunctionSearchOrder functionSearchOrder)	Specify an ordering to the search results.
void	searchAmongFunctions(IdList functionIds)	Execute this search among the given list of functions.

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

searchAmongFunctions

void searchAmongFunctions(IdList functionIds)

Execute this search among the given list of functions.

Parameters:

functionIds - list of functions

Throws:

NullArgumentException - functionIds is null

Compliance:

mandatory - This method must be implemented.

orderFunctionResults

void orderFunctionResults(FunctionSearchOrder functionSearchOrder)

Specify an ordering to the search results.

Parameters:

functionSearchOrder - function search order

Throws:

NullArgumentException - functionSearchOrder is null

UnsupportedException - functionSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getFunctionSearchRecord

FunctionSearchRecord getFunctionSearchRecord(Type functionSearchRecordType)
                                      throws OperationFailedException

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

Parameters:

functionSearchRecordType - a function search record type

Returns:

the function search record

Throws:

NullArgumentException - functionSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(functionSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.