Interface TriggerEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface TriggerEnablerSearch
extends OsidSearch

The search interface for governing trigger enabler searches.

Method Summary

Modifier and Type	Method	Description
TriggerEnablerSearchRecord	getTriggerEnablerSearchRecord(Type triggerEnablerSearchRecordType)	Gets the trigger enabler search record corresponding to the given trigger enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderTriggerEnablerResults(TriggerEnablerSearchOrder triggerEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongTriggerEnablers(IdList triggerEnablerIds)	Execute this search among the given list of trigger 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

searchAmongTriggerEnablers

void searchAmongTriggerEnablers(IdList triggerEnablerIds)

Execute this search among the given list of trigger enablers.

Parameters:

triggerEnablerIds - list of trigger enablers

Throws:

NullArgumentException - triggerEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderTriggerEnablerResults

void orderTriggerEnablerResults(TriggerEnablerSearchOrder triggerEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

triggerEnablerSearchOrder - trigger enabler search order

Throws:

NullArgumentException - triggerEnablerSearchOrder is null

UnsupportedException - triggerEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getTriggerEnablerSearchRecord

TriggerEnablerSearchRecord getTriggerEnablerSearchRecord(Type triggerEnablerSearchRecordType)
                                                  throws OperationFailedException

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

Parameters:

triggerEnablerSearchRecordType - a trigger enabler search record type

Returns:

the trigger enabler search record

Throws:

NullArgumentException - triggerEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(triggerEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.