Interface InputEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface InputEnablerSearch
extends OsidSearch

The search interface for governing input enabler searches.

Method Summary

Modifier and Type	Method	Description
InputEnablerSearchRecord	getInputEnablerSearchRecord(Type inputEnablerSearchRecordType)	Gets the input enabler search record corresponding to the given input enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderInputEnablerResults(InputEnablerSearchOrder inputEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongInputEnablers(IdList inputEnablerIds)	Execute this search among the given list of input enablers.

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

searchAmongInputEnablers

void searchAmongInputEnablers(IdList inputEnablerIds)

Execute this search among the given list of input enablers.

Parameters:

inputEnablerIds - list of input enablers

Throws:

NullArgumentException - inputEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderInputEnablerResults

void orderInputEnablerResults(InputEnablerSearchOrder inputEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

inputEnablerSearchOrder - input enabler search order

Throws:

NullArgumentException - inputEnablerSearchOrder is null

UnsupportedException - inputEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getInputEnablerSearchRecord

InputEnablerSearchRecord getInputEnablerSearchRecord(Type inputEnablerSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

inputEnablerSearchRecordType - an input enabler search record type

Returns:

the input enabler search record

Throws:

NullArgumentException - inputEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inputEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.