Interface ModelSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ModelSearch
extends OsidSearch

The search interface for governing model searches.

Method Summary

Modifier and Type	Method	Description
ModelSearchRecord	getModelSearchRecord(Type modelSearchRecordType)	Gets the model search record corresponding to the given model search record Type .
void	orderModelResults(ModelSearchOrder modelSearchOrder)	Specify an ordering to the search results.
void	searchAmongModels(IdList modelIds)	Execute this search among the given list of models.

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

searchAmongModels

void searchAmongModels(IdList modelIds)

Execute this search among the given list of models.

Parameters:

modelIds - list of models

Throws:

NullArgumentException - modelIds is null

Compliance:

mandatory - This method must be implemented.

orderModelResults

void orderModelResults(ModelSearchOrder modelSearchOrder)

Specify an ordering to the search results.

Parameters:

modelSearchOrder - model search order

Throws:

NullArgumentException - modelSearchOrder is null

UnsupportedException - modelSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getModelSearchRecord

ModelSearchRecord getModelSearchRecord(Type modelSearchRecordType)
                                throws OperationFailedException

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

Parameters:

modelSearchRecordType - a model search record type

Returns:

the model search record

Throws:

NullArgumentException - modelSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(modelSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.