Interface SignalEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface SignalEnablerSearch
extends OsidSearch

The search interface for governing signal enabler searches.

Method Summary

Modifier and Type	Method	Description
SignalEnablerSearchRecord	getSignalEnablerSearchRecord(Type signalEnablerSearchRecordType)	Gets the signal enabler search record corresponding to the given signal enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderSignalEnablerResults(SignalEnablerSearchOrder signalEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongSignalEnablers(IdList mapIds)	Execute this search among the given list of signal 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

searchAmongSignalEnablers

void searchAmongSignalEnablers(IdList mapIds)

Execute this search among the given list of signal enablers.

Parameters:

mapIds - list of signal enablers

Throws:

NullArgumentException - mapIds is null

Compliance:

mandatory - This method must be implemented.

orderSignalEnablerResults

void orderSignalEnablerResults(SignalEnablerSearchOrder signalEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

signalEnablerSearchOrder - signal enabler search order

Throws:

NullArgumentException - signalEnablerSearchOrder is null

UnsupportedException - signalEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getSignalEnablerSearchRecord

SignalEnablerSearchRecord getSignalEnablerSearchRecord(Type signalEnablerSearchRecordType)
                                                throws OperationFailedException

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

Parameters:

signalEnablerSearchRecordType - a signal enabler search record type

Returns:

the signal enabler search record

Throws:

NullArgumentException - signalEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(signalEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.