Interface DepotSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface DepotSearch
extends OsidSearch

The interface for governing depot searches.

Method Summary

Modifier and Type	Method	Description
DepotSearchRecord	getDepotSearchRecord(Type depotSearchRecordType)	Gets the depot search record corresponding to the given depot search record Type .
void	orderDepotResults(DepotSearchOrder depotSearchOrder)	Specify an ordering to the search results.
void	searchAmongDepots(IdList depotIds)	Execute this search among the given list of depots.

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

searchAmongDepots

void searchAmongDepots(IdList depotIds)

Execute this search among the given list of depots.

Parameters:

depotIds - list of depots

Throws:

NullArgumentException - depotIds is null

Compliance:

mandatory - This method must be implemented.

orderDepotResults

void orderDepotResults(DepotSearchOrder depotSearchOrder)

Specify an ordering to the search results.

Parameters:

depotSearchOrder - depot search order

Throws:

NullArgumentException - depotSearchOrder is null

UnsupportedException - depotSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getDepotSearchRecord

DepotSearchRecord getDepotSearchRecord(Type depotSearchRecordType)
                                throws OperationFailedException

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

Parameters:

depotSearchRecordType - a depot search record type

Returns:

the depot search record

Throws:

NullArgumentException - depotSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(depotSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.