Interface FoundrySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface FoundrySearch
extends OsidSearch

The search interface for governing foundry searches.

Method Summary

Modifier and Type	Method	Description
FoundrySearchRecord	getFoundrySearchRecord(Type foundrySearchRecordType)	Gets the foundry search record corresponding to the given foundry search record Type.
void	orderFoundryResults(FoundrySearchOrder foundrySearchOrder)	Specify an ordering to the search results.
void	searchAmongFoundries(IdList foundryIds)	Execute this search among the given list of foundries.

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

searchAmongFoundries

void searchAmongFoundries(IdList foundryIds)

Execute this search among the given list of foundries.

Parameters:

foundryIds - list of foundries

Throws:

NullArgumentException - foundryIds is null

Compliance:

mandatory - This method must be implemented.

orderFoundryResults

void orderFoundryResults(FoundrySearchOrder foundrySearchOrder)

Specify an ordering to the search results.

Parameters:

foundrySearchOrder - foundry search order

Throws:

NullArgumentException - foundrySearchOrder is null

UnsupportedException - foundrySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getFoundrySearchRecord

FoundrySearchRecord getFoundrySearchRecord(Type foundrySearchRecordType)
                                    throws OperationFailedException

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

Parameters:

foundrySearchRecordType - a foundry search record type

Returns:

the foundry search record

Throws:

NullArgumentException - foundrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(foundrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.