Interface RelevancyEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface RelevancyEnablerSearch
extends OsidSearch

The search interface for governing relevancy enabler searches.

Method Summary

Modifier and Type	Method	Description
RelevancyEnablerSearchRecord	getRelevancyEnablerSearchRecord(Type relevancyEnablerSearchRecordType)	Gets the relevancy enabler search record corresponding to the given relevancy enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderRelevancyEnablerResults(RelevancyEnablerSearchOrder relevancyEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongRelevancyEnablers(IdList relevancyEnablerIds)	Execute this search among the given list of relevancy enablers.

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

searchAmongRelevancyEnablers

void searchAmongRelevancyEnablers(IdList relevancyEnablerIds)

Execute this search among the given list of relevancy enablers.

Parameters:

relevancyEnablerIds - list of relevancy enablers

Throws:

NullArgumentException - relevancyEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderRelevancyEnablerResults

void orderRelevancyEnablerResults(RelevancyEnablerSearchOrder relevancyEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

relevancyEnablerSearchOrder - relevancy enabler search order

Throws:

NullArgumentException - relevancyEnablerSearchOrder is null

UnsupportedException - relevancyEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getRelevancyEnablerSearchRecord

RelevancyEnablerSearchRecord getRelevancyEnablerSearchRecord(Type relevancyEnablerSearchRecordType)
                                                      throws OperationFailedException

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

Parameters:

relevancyEnablerSearchRecordType - a relevancy enabler search record type

Returns:

the relevancy enabler search record

Throws:

NullArgumentException - relevancyEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(relevancyEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.