Interface TriggerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface TriggerSearch
extends OsidSearch

The search interface for governing trigger searches.

Method Summary

Modifier and Type	Method	Description
TriggerSearchRecord	getTriggerSearchRecord(Type triggerSearchRecordType)	Gets the trigger search record corresponding to the given trigger search record Type.
void	orderTriggerResults(TriggerSearchOrder triggerSearchOrder)	Specify an ordering to the search results.
void	searchAmongTriggers(IdList triggerIds)	Execute this search among the given list of triggers.

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

searchAmongTriggers

void searchAmongTriggers(IdList triggerIds)

Execute this search among the given list of triggers.

Parameters:

triggerIds - list of triggers

Throws:

NullArgumentException - triggerIds is null

Compliance:

mandatory - This method must be implemented.

orderTriggerResults

void orderTriggerResults(TriggerSearchOrder triggerSearchOrder)

Specify an ordering to the search results.

Parameters:

triggerSearchOrder - trigger search order

Throws:

NullArgumentException - triggerSearchOrder is null

UnsupportedException - triggerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getTriggerSearchRecord

TriggerSearchRecord getTriggerSearchRecord(Type triggerSearchRecordType)
                                    throws OperationFailedException

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

Parameters:

triggerSearchRecordType - a trigger search record type

Returns:

the trigger search record

Throws:

NullArgumentException - triggerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(triggerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.