Interface RealmSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface RealmSearch
extends OsidSearch

The search interface for governing realm searches.

Method Summary

Modifier and Type	Method	Description
RealmSearchRecord	getRealmSearchRecord(Type realmSearchRecordType)	Gets the record corresponding to the given realm search record Type .
void	orderRealmResults(RealmSearchOrder realmSearchOrder)	Specify an ordering to the search results.
void	searchAmongRealms(IdList realmIds)	Execute this search among the given list of realms.

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

searchAmongRealms

void searchAmongRealms(IdList realmIds)

Execute this search among the given list of realms.

Parameters:

realmIds - list of realms

Throws:

NullArgumentException - realmIds is null

Compliance:

mandatory - This method must be implemented.

orderRealmResults

void orderRealmResults(RealmSearchOrder realmSearchOrder)

Specify an ordering to the search results.

Parameters:

realmSearchOrder - realm search order

Throws:

NullArgumentException - realmSearchOrder is null

UnsupportedException - realmSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getRealmSearchRecord

RealmSearchRecord getRealmSearchRecord(Type realmSearchRecordType)
                                throws OperationFailedException

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

Parameters:

realmSearchRecordType - a realm search record type

Returns:

the realm search record

Throws:

NullArgumentException - realmSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(realmSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.