Interface DispatchSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface DispatchSearch
extends OsidSearch

The search interface for governing dispatch searches.

Method Summary

Modifier and Type	Method	Description
DispatchSearchRecord	getDispatchSearchRecord(Type dispatchSearchRecordType)	Gets the dis[atch search record corresponding to the given dispatch search record Type .
void	orderDispatchResults(DispatchSearchOrder dispatchSearchOrder)	Specify an ordering to the search results.
void	searchAmongDispatches(IdList dispatchIds)	Execute this search among the given list of dispatches.

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

searchAmongDispatches

void searchAmongDispatches(IdList dispatchIds)

Execute this search among the given list of dispatches.

Parameters:

dispatchIds - list of dispatches

Throws:

NullArgumentException - dispatchIds is null

Compliance:

mandatory - This method must be implemented.

orderDispatchResults

void orderDispatchResults(DispatchSearchOrder dispatchSearchOrder)

Specify an ordering to the search results.

Parameters:

dispatchSearchOrder - dispatch search order

Throws:

NullArgumentException - dispatchSearchOrder is null

UnsupportedException - dispatchSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getDispatchSearchRecord

DispatchSearchRecord getDispatchSearchRecord(Type dispatchSearchRecordType)
                                      throws OperationFailedException

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

Parameters:

dispatchSearchRecordType - a dispatch search record type

Returns:

the dispatch search record

Throws:

NullArgumentException - dispatchSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(dispatchSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.