Interface HoldSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface HoldSearch
extends OsidSearch

The search interface for governing hold searches.

Method Summary

Modifier and Type	Method	Description
HoldSearchRecord	getHoldSearchRecord(Type holdSearchRecordType)	Gets the hold search record corresponding to the given hold search record Type.
void	orderHoldResults(HoldSearchOrder holdSearchOrder)	Specify an ordering to the search results.
void	searchAmongHolds(IdList holdIds)	Execute this search among the given list of holds.

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

searchAmongHolds

void searchAmongHolds(IdList holdIds)

Execute this search among the given list of holds.

Parameters:

holdIds - list of holds

Throws:

NullArgumentException - holdIds is null

Compliance:

mandatory - This method must be implemented.

orderHoldResults

void orderHoldResults(HoldSearchOrder holdSearchOrder)

Specify an ordering to the search results.

Parameters:

holdSearchOrder - hold search order

Throws:

NullArgumentException - holdSearchOrder is null

UnsupportedException - holdSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getHoldSearchRecord

HoldSearchRecord getHoldSearchRecord(Type holdSearchRecordType)
                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

holdSearchRecordType - a hold search record type

Returns:

the hold search record

Throws:

NullArgumentException - holdSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(holdSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.