Interface RealmSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface RealmSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	Description
RealmQueryInspector	getRealmQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
RealmList	getRealms()	Gets the realm list resulting from a search.
RealmSearchResultsRecord	getRealmSearchResultsRecord(Type realmSearchRecordType)	Gets the record corresponding to the given realm search record Type.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getRealms

RealmList getRealms()

Gets the realm list resulting from a search.

Returns:

the realm list

Throws:

IllegalStateException - the list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getRealmQueryInspector

RealmQueryInspector getRealmQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getRealmSearchResultsRecord

RealmSearchResultsRecord getRealmSearchResultsRecord(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 results record

Throws:

NullArgumentException - realmSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(realmSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.