Interface OffsetEventSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface OffsetEventSearch
extends OsidSearch

OffsetEventSearch defines the interface for specifying offset event search options.

Method Summary

Modifier and Type	Method	Description
OffsetEventSearchRecord	getOffsetEventSearchRecord(Type offsetEventSearchRecordType)	Gets the offset event search record corresponding to the given offset event search record Type .
void	orderOffsetEventResults(OffsetEventSearchOrder offsetEventSearchOrder)	Specify an ordering to the search results.
void	searchAmongOffsetEvents(IdList offsetEventIds)	Execute this search among the given list of offset 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

searchAmongOffsetEvents

void searchAmongOffsetEvents(IdList offsetEventIds)

Execute this search among the given list of offset events.

Parameters:

offsetEventIds - list of offset events

Throws:

NullArgumentException - offsetEventIds is null

Compliance:

mandatory - This method must be implemented.

orderOffsetEventResults

void orderOffsetEventResults(OffsetEventSearchOrder offsetEventSearchOrder)

Specify an ordering to the search results.

Parameters:

offsetEventSearchOrder - offset event search order

Throws:

NullArgumentException - offsetEventSearchOrder is null

UnsupportedException - offsetEventSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getOffsetEventSearchRecord

OffsetEventSearchRecord getOffsetEventSearchRecord(Type offsetEventSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

offsetEventSearchRecordType - an offset event search record type

Returns:

the offset event search record

Throws:

NullArgumentException - offsetEventSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(offsetEventSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.