Interface RelevancySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface RelevancySearch
extends OsidSearch

RelevancySearch defines the interface for specifying relevancy search options.

Method Summary

Modifier and Type	Method	Description
RelevancySearchRecord	getRelevancySearchRecord(Type relevancySearchRecordType)	Gets the relevancy search record corresponding to the given relevancy search record Type.
void	orderRelevancyResults(RelevancySearchOrder relevancySearchOrder)	Specify an ordering to the search results.
void	searchAmongRelevancies(IdList relevancyIds)	Execute this search among the given list of relevancies.

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

searchAmongRelevancies

void searchAmongRelevancies(IdList relevancyIds)

Execute this search among the given list of relevancies.

Parameters:

relevancyIds - list of relevancies

Throws:

NullArgumentException - relevancyIds is null

Compliance:

mandatory - This method must be implemented.

orderRelevancyResults

void orderRelevancyResults(RelevancySearchOrder relevancySearchOrder)

Specify an ordering to the search results.

Parameters:

relevancySearchOrder - relevancy search order

Throws:

NullArgumentException - relevancySearchOrder is null

UnsupportedException - relevancySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getRelevancySearchRecord

RelevancySearchRecord getRelevancySearchRecord(Type relevancySearchRecordType)
                                        throws OperationFailedException,
PermissionDeniedException

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

Parameters:

relevancySearchRecordType - a relevancy search record type

Returns:

the relevancy search record

Throws:

NullArgumentException - relevancySearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(relevancySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.