Interface SupersedingEventEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface SupersedingEventEnablerSearch
extends OsidSearch

The search interface for governing superseding event enabler searches.

Method Summary

Modifier and Type	Method	Description
SupersedingEventEnablerSearchRecord	getSupersedingEventEnablerSearchRecord(Type supersedingEventEnablerSearchRecordType)	Gets the superseding event enabler search record corresponding to the given superseding event enabler search record Type.
void	orderSupersedingEventEnablerResults(SupersedingEventEnablerSearchOrder supersedingEventEnablerSearchOrder)	Specify a superseding event ordering to the search results.
void	searchAmongSupersedingEventEnablers(IdList supersedingEventEnablerIds)	Execute this search among the given list of superseding 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

searchAmongSupersedingEventEnablers

void searchAmongSupersedingEventEnablers(IdList supersedingEventEnablerIds)

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

Parameters:

supersedingEventEnablerIds - list of superseding event enablers

Throws:

NullArgumentException - supersedingEventEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderSupersedingEventEnablerResults

void orderSupersedingEventEnablerResults(SupersedingEventEnablerSearchOrder supersedingEventEnablerSearchOrder)

Specify a superseding event ordering to the search results.

Parameters:

supersedingEventEnablerSearchOrder - superseding event enabler search order

Throws:

NullArgumentException - supersdeingEventEnablerSearchOrder is null

UnsupportedException - supersedingEventEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getSupersedingEventEnablerSearchRecord

SupersedingEventEnablerSearchRecord getSupersedingEventEnablerSearchRecord(Type supersedingEventEnablerSearchRecordType)
                                                                    throws OperationFailedException

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

Parameters:

supersedingEventEnablerSearchRecordType - a superseding event enabler search record type

Returns:

the superseding event enabler search record

Throws:

NullArgumentException - supersedingEventEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(supersedingEventEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.