Interface DispatchEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface DispatchEnablerSearch
extends OsidSearch

The search interface for governing dispatch enabler searches.

Method Summary

Modifier and Type	Method	Description
DispatchEnablerSearchRecord	getDispatchEnablerSearchRecord(Type dispatchEnablerSearchRecordType)	Gets the dispatch enabler search record corresponding to the given dispatch enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderDispatchEnablerResults(DispatchEnablerSearchOrder dispatchEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongDispatchEnablers(IdList dispatchEnablerIds)	Execute this search among the given list of dispatch 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

searchAmongDispatchEnablers

void searchAmongDispatchEnablers(IdList dispatchEnablerIds)

Execute this search among the given list of dispatch enablers.

Parameters:

dispatchEnablerIds - list of dispatch enablers

Throws:

NullArgumentException - dispatchEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderDispatchEnablerResults

void orderDispatchEnablerResults(DispatchEnablerSearchOrder dispatchEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

dispatchEnablerSearchOrder - dispatch enabler search order

Throws:

NullArgumentException - dispatchEnablerSearchOrder is null

UnsupportedException - dispatchEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getDispatchEnablerSearchRecord

DispatchEnablerSearchRecord getDispatchEnablerSearchRecord(Type dispatchEnablerSearchRecordType)
                                                    throws OperationFailedException

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

Parameters:

dispatchEnablerSearchRecordType - a dispatch enabler search record type

Returns:

the dispatch enabler search record

Throws:

NullArgumentException - dispatchEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(dispatchEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.