Interface HoldEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface HoldEnablerSearch
extends OsidSearch

The search interface for governing hold enabler searches.

Method Summary

Modifier and Type	Method	Description
HoldEnablerSearchRecord	getHoldEnablerSearchRecord(Type holdEnablerSearchRecordType)	Gets the hold enabler search record corresponding to the given hold enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderHoldEnablerResults(HoldEnablerSearchOrder holdEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongHoldEnablers(IdList holdEnablerIds)	Execute this search among the given list of hold 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

searchAmongHoldEnablers

void searchAmongHoldEnablers(IdList holdEnablerIds)

Execute this search among the given list of hold enablers.

Parameters:

holdEnablerIds - list of hold enablers

Throws:

NullArgumentException - holdEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderHoldEnablerResults

void orderHoldEnablerResults(HoldEnablerSearchOrder holdEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

holdEnablerSearchOrder - hold enabler search order

Throws:

NullArgumentException - holdEnablerSearchOrder is null

UnsupportedException - holdEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getHoldEnablerSearchRecord

HoldEnablerSearchRecord getHoldEnablerSearchRecord(Type holdEnablerSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

holdEnablerSearchRecordType - a hold enabler search record type

Returns:

the hold enabler search record

Throws:

NullArgumentException - holdEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(holdEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.