Interface DispatchConstrainerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface DispatchConstrainerSearch
extends OsidSearch

The search interface for governing dispatch constrainer searches.

Method Summary

Modifier and Type	Method	Description
DispatchConstrainerSearchRecord	getDispatchConstrainerSearchRecord(Type dispatchConstrainerSearchRecordType)	Gets the dispatch constrainer search record corresponding to the given dispatch constrainer search record Type.
void	orderDispatchConstrainerResults(DispatchConstrainerSearchOrder dispatchConstrainerSearchOrder)	Specify an ordering to the search results.
void	searchAmongDispatchConstrainers(IdList dispatchConstrainerIds)	Execute this search among the given list of dispatch constrainers.

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

searchAmongDispatchConstrainers

void searchAmongDispatchConstrainers(IdList dispatchConstrainerIds)

Execute this search among the given list of dispatch constrainers.

Parameters:

dispatchConstrainerIds - list of dispatch constrainer

Throws:

NullArgumentException - dispatchConstrainerIds is null

Compliance:

mandatory - This method must be implemented.

orderDispatchConstrainerResults

void orderDispatchConstrainerResults(DispatchConstrainerSearchOrder dispatchConstrainerSearchOrder)

Specify an ordering to the search results.

Parameters:

dispatchConstrainerSearchOrder - dispatch constrainer search order

Throws:

NullArgumentException - dispatchConstrainerSearchOrder is null

UnsupportedException - dispatchConstrainerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getDispatchConstrainerSearchRecord

DispatchConstrainerSearchRecord getDispatchConstrainerSearchRecord(Type dispatchConstrainerSearchRecordType)
                                                            throws OperationFailedException

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

Parameters:

dispatchConstrainerSearchRecordType - a dispatch constrainer search record type

Returns:

the dispatch constrainer search record

Throws:

NullArgumentException - dispatchConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(dispatchConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.