Interface InputSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface InputSearch
extends OsidSearch

The search interface for governing input searches.

Method Summary

Modifier and Type	Method	Description
InputSearchRecord	getInputSearchRecord(Type inputSearchRecordType)	Gets the input search record corresponding to the given input search record Type.
void	orderInputResults(InputSearchOrder inputSearchOrder)	Specify an ordering to the search results.
void	searchAmongInputs(IdList inputIds)	Execute this search among the given list of inputs.

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

searchAmongInputs

void searchAmongInputs(IdList inputIds)

Execute this search among the given list of inputs.

Parameters:

inputIds - list of inputs

Throws:

NullArgumentException - inputIds is null

Compliance:

mandatory - This method must be implemented.

orderInputResults

void orderInputResults(InputSearchOrder inputSearchOrder)

Specify an ordering to the search results.

Parameters:

inputSearchOrder - input search order

Throws:

NullArgumentException - inputSearchOrder is null

UnsupportedException - inputSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getInputSearchRecord

InputSearchRecord getInputSearchRecord(Type inputSearchRecordType)
                                throws OperationFailedException

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

Parameters:

inputSearchRecordType - an input search record type

Returns:

the input search record

Throws:

NullArgumentException - inputSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inputSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.