Interface DispatchProcessorEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface DispatchProcessorEnablerSearch
extends OsidSearch

The search interface for governing dispatch processor enabler searches.

Method Summary

Modifier and Type	Method	Description
DispatchProcessorEnablerSearchRecord	getDispatchProcessorEnablerSearchRecord(Type dispatchProcessorEnablerSearchRecordType)	Gets the dispatch processor enabler search record corresponding to the given dispatch processor enabler search record Type.
void	orderDispatchProcessorEnablerResults(DispatchProcessorEnablerSearchOrder dispatchProcessorEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongDispatchProcessorEnablers(IdList dispatchProcessorEnablerIds)	Execute this search among the given list of dispatch processor 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

searchAmongDispatchProcessorEnablers

void searchAmongDispatchProcessorEnablers(IdList dispatchProcessorEnablerIds)

Execute this search among the given list of dispatch processor enablers.

Parameters:

dispatchProcessorEnablerIds - list of dispatch processor enablers

Throws:

NullArgumentException - dispatchProcessorEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderDispatchProcessorEnablerResults

void orderDispatchProcessorEnablerResults(DispatchProcessorEnablerSearchOrder dispatchProcessorEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

dispatchProcessorEnablerSearchOrder - dispatch processor enabler search order

Throws:

NullArgumentException - dispatchProcessorEnablerSearchOrder is null

UnsupportedException - dispatchProcessorEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getDispatchProcessorEnablerSearchRecord

DispatchProcessorEnablerSearchRecord getDispatchProcessorEnablerSearchRecord(Type dispatchProcessorEnablerSearchRecordType)
                                                                      throws OperationFailedException

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

Parameters:

dispatchProcessorEnablerSearchRecordType - a dispatch processor enabler search record type

Returns:

the dispatch processor enabler search record

Throws:

NullArgumentException - dispatchProcessorEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(dispatchProcessorEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.