Interface ChainSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ChainSearch
extends OsidSearch

The search interface for governing chain searches.

Method Summary

Modifier and Type	Method	Description
ChainSearchRecord	getChainSearchRecord(Type chainSearchRecordType)	Gets the chain search record corresponding to the given chain search record Type.
void	orderChainResults(ChainSearchOrder chainSearchOrder)	Specify an ordering to the search results.
void	searchAmongChains(IdList chainIds)	Execute this search among the given list of chains.

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

searchAmongChains

void searchAmongChains(IdList chainIds)

Execute this search among the given list of chains.

Parameters:

chainIds - list of chains

Throws:

NullArgumentException - chainIds is null

Compliance:

mandatory - This method must be implemented.

orderChainResults

void orderChainResults(ChainSearchOrder chainSearchOrder)

Specify an ordering to the search results.

Parameters:

chainSearchOrder - chain search order

Throws:

NullArgumentException - chainSearchOrder is null

UnsupportedException - chainSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getChainSearchRecord

ChainSearchRecord getChainSearchRecord(Type chainSearchRecordType)
                                throws OperationFailedException

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

Parameters:

chainSearchRecordType - a chain search record type

Returns:

the chain search interface

Throws:

NullArgumentException - chainSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(chainSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.