Interface RecurringEventEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface RecurringEventEnablerSearch
extends OsidSearch

The search interface for governing recurring event enabler searches.

Method Summary

Modifier and Type	Method	Description
RecurringEventEnablerSearchRecord	getRecurringEventEnablerSearchRecord(Type recurringEventEnablerSearchRecordType)	Gets the recurring event enabler search record corresponding to the given recurring event enabler search record Type.
void	orderRecurringEventEnablerResults(RecurringEventEnablerSearchOrder recurringEventEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongRecurringEventEnablers(IdList recurringEventEnablerIds)	Execute this search among the given list of recurring event 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

searchAmongRecurringEventEnablers

void searchAmongRecurringEventEnablers(IdList recurringEventEnablerIds)

Execute this search among the given list of recurring event enablers.

Parameters:

recurringEventEnablerIds - list of recurring event enablers

Throws:

NullArgumentException - recurringEventEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderRecurringEventEnablerResults

void orderRecurringEventEnablerResults(RecurringEventEnablerSearchOrder recurringEventEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

recurringEventEnablerSearchOrder - recurring event enabler search order

Throws:

NullArgumentException - recurringEventEnablerSearchOrder is null

UnsupportedException - recurringEventEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getRecurringEventEnablerSearchRecord

RecurringEventEnablerSearchRecord getRecurringEventEnablerSearchRecord(Type recurringEventEnablerSearchRecordType)
                                                                throws OperationFailedException

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

Parameters:

recurringEventEnablerSearchRecordType - a recurring event enabler search record type

Returns:

the recurring event enabler search record

Throws:

NullArgumentException - recurringEventEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(recurringEventEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.