Interface OffsetEventEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface OffsetEventEnablerSearch
extends OsidSearch

The search interface for governing offset event enabler searches.

Method Summary

Modifier and Type	Method	Description
OffsetEventEnablerSearchRecord	getOffsetEventEnablerSearchRecord(Type offsetEventEnablerSearchRecordType)	Gets the offset event enabler search record corresponding to the given offset event enabler search record Type.
void	orderOffsetEventEnablerResults(OffsetEventEnablerSearchOrder offsetEventEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongOffsetEventEnablers(IdList offsetEventEnablerIds)	Execute this search among the given list of offset 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

searchAmongOffsetEventEnablers

void searchAmongOffsetEventEnablers(IdList offsetEventEnablerIds)

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

Parameters:

offsetEventEnablerIds - list of offset event enablers

Throws:

NullArgumentException - offsetEventEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderOffsetEventEnablerResults

void orderOffsetEventEnablerResults(OffsetEventEnablerSearchOrder offsetEventEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

offsetEventEnablerSearchOrder - offset event enabler search order

Throws:

NullArgumentException - offsetEventEnablerSearchOrder is null

UnsupportedException - offsetEventEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getOffsetEventEnablerSearchRecord

OffsetEventEnablerSearchRecord getOffsetEventEnablerSearchRecord(Type offsetEventEnablerSearchRecordType)
                                                          throws OperationFailedException

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

Parameters:

offsetEventEnablerSearchRecordType - an offset event enabler search record type

Returns:

the offset event enabler search record

Throws:

NullArgumentException - offsetEventEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(offsetEventEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.