Interface DispatchConstrainerEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface DispatchConstrainerEnablerSearch
extends OsidSearch

The search interface for governing dispatch constrainer enabler searches.

Method Summary

Modifier and Type	Method	Description
DispatchConstrainerEnablerSearchRecord	getDispatchConstrainerEnablerSearchRecord(Type dispatchConstrainerEnablerSearchRecordType)	Gets the dispatch constrainer enabler search record corresponding to the given dispatch constrainer enabler search record Type.
void	orderDispatchConstrainerEnablerResults(DispatchConstrainerEnablerSearchOrder dispatchConstrainerEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongDispatchConstrainerEnablers(IdList dispatchConstrainerEnablerIds)	Execute this search among the given list of dispatch constrainer 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

searchAmongDispatchConstrainerEnablers

void searchAmongDispatchConstrainerEnablers(IdList dispatchConstrainerEnablerIds)

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

Parameters:

dispatchConstrainerEnablerIds - list of dispatch constrainer enablers

Throws:

NullArgumentException - dispatchConstrainerEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderDispatchConstrainerEnablerResults

void orderDispatchConstrainerEnablerResults(DispatchConstrainerEnablerSearchOrder dispatchConstrainerEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

dispatchConstrainerEnablerSearchOrder - dispatch constrainer enabler search order

Throws:

NullArgumentException - dispatchConstrainerEnablerSearchOrder is null

UnsupportedException - dispatchConstrainerEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getDispatchConstrainerEnablerSearchRecord

DispatchConstrainerEnablerSearchRecord getDispatchConstrainerEnablerSearchRecord(Type dispatchConstrainerEnablerSearchRecordType)
                                                                          throws OperationFailedException

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

Parameters:

dispatchConstrainerEnablerSearchRecordType - a dispatch constrainer enabler search record type

Returns:

the dispatch constrainer enabler search record

Throws:

NullArgumentException - dispatchConstrainerEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(dispatchConstrainerEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.