Interface DispatchProcessorSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface DispatchProcessorSearch
extends OsidSearch

The search interface for governing dispatch processor searches.

Method Summary

Modifier and Type	Method	Description
DispatchProcessorSearchRecord	getDispatchProcessorSearchRecord(Type dispatchProcessorSearchRecordType)	Gets the dispatch processor search record corresponding to the given dispatch processor search record Type .This method is used to retrieve an object implementing the requested record.
void	orderDispatchProcessorResults(DispatchProcessorSearchOrder dispatchProcessorSearchOrder)	Specify an ordering to the search results.
void	searchAmongDispatchProcessors(IdList dispatchProcessorIds)	Execute this search among the given list of dispatch processors.

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

searchAmongDispatchProcessors

void searchAmongDispatchProcessors(IdList dispatchProcessorIds)

Execute this search among the given list of dispatch processors.

Parameters:

dispatchProcessorIds - list of dispatch processors

Throws:

NullArgumentException - dispatchProcessorIds is null

Compliance:

mandatory - This method must be implemented.

orderDispatchProcessorResults

void orderDispatchProcessorResults(DispatchProcessorSearchOrder dispatchProcessorSearchOrder)

Specify an ordering to the search results.

Parameters:

dispatchProcessorSearchOrder - dispatch processor search order

Throws:

NullArgumentException - dispatchProcessorSearchOrder is null

UnsupportedException - dispatchProcessorSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getDispatchProcessorSearchRecord

DispatchProcessorSearchRecord getDispatchProcessorSearchRecord(Type dispatchProcessorSearchRecordType)
                                                        throws OperationFailedException

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

Parameters:

dispatchProcessorSearchRecordType - a dispatch processor search record type

Returns:

the dispatch processor search record

Throws:

NullArgumentException - dispatchProcessorSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(dispatchProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.