Interface SupersedingEventSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface SupersedingEventSearch
extends OsidSearch

SupersedingEventSearch defines the interface for specifying superseding event search options.

Method Summary

Modifier and Type	Method	Description
SupersedingEventSearchRecord	getSupersedingEventSearchRecord(Type supersedingEventSearchRecordType)	Gets the superseding event search record corresponding to the given superseding event search record Type .
void	orderSupersedingEventResults(SupersedingEventSearchOrder supersedingEventSearchOrder)	Specify an ordering to the search results.
void	searchAmongSupersedingEvents(IdList supersedingEventIds)	Execute this search among the given list of superseding events.

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

searchAmongSupersedingEvents

void searchAmongSupersedingEvents(IdList supersedingEventIds)

Execute this search among the given list of superseding events.

Parameters:

supersedingEventIds - list of superseding events

Throws:

NullArgumentException - supersedingEventIds is null

Compliance:

mandatory - This method must be implemented.

orderSupersedingEventResults

void orderSupersedingEventResults(SupersedingEventSearchOrder supersedingEventSearchOrder)

Specify an ordering to the search results.

Parameters:

supersedingEventSearchOrder - superseding event search order

Throws:

NullArgumentException - supersedingEventSearchOrder is null

UnsupportedException - superedingEventSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getSupersedingEventSearchRecord

SupersedingEventSearchRecord getSupersedingEventSearchRecord(Type supersedingEventSearchRecordType)
                                                      throws OperationFailedException

Gets the superseding event search record corresponding to the given superseding event search record Type .

Parameters:

supersedingEventSearchRecordType - a superseding event search record type

Returns:

the superseding event search record

Throws:

NullArgumentException - supersedingEventSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(supersedingEventSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.