Interface AntimatroidSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AntimatroidSearch
extends OsidSearch

The search interface for governing antimatroid searches.

Method Summary

Modifier and Type	Method	Description
AntimatroidSearchRecord	getAntimatroidSearchRecord(Type antimatroidSearchRecordType)	Gets the antimatroid search record corresponding to the given antimatroid search record Type .This method is used to retrieve an object implementing the requested record.
void	orderAntimatroidResults(AntimatroidSearchOrder antimatroidSearchOrder)	Specify an ordering to the search results.
void	searchAmongAntimatroids(IdList antimatroidIds)	Execute this search among the given list of antimatroids.

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

searchAmongAntimatroids

void searchAmongAntimatroids(IdList antimatroidIds)

Execute this search among the given list of antimatroids.

Parameters:

antimatroidIds - list of antimatroids

Throws:

NullArgumentException - antimatroidIds is null

Compliance:

mandatory - This method must be implemented.

orderAntimatroidResults

void orderAntimatroidResults(AntimatroidSearchOrder antimatroidSearchOrder)

Specify an ordering to the search results.

Parameters:

antimatroidSearchOrder - antimatroid search order

Throws:

NullArgumentException - antimatroidSearchOrder is null

UnsupportedException - antimatroidSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAntimatroidSearchRecord

AntimatroidSearchRecord getAntimatroidSearchRecord(Type antimatroidSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

antimatroidSearchRecordType - an antimatroid search record type

Returns:

the antimatroid search record

Throws:

NullArgumentException - antimatroidSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(antimatroidSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.