public interface RealmSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and 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.
|
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
RealmList getRealms()
IllegalStateException
- the list has already been
retrievedmandatory
- This method must be implemented. RealmQueryInspector getRealmQueryInspector()
mandatory
- This method must be implemented. RealmSearchResultsRecord getRealmSearchResultsRecord(Type realmSearchRecordType) throws OperationFailedException
realmSearchRecordType
- a realm search record typeNullArgumentException
- realmSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(realmSearchRecordType)
is false
mandatory
- This method must be implemented.