public interface RealmSearch extends OsidSearch
The search interface for governing realm searches.
Modifier and Type | Method and 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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongRealms(IdList realmIds)
realmIds
- list of realmsNullArgumentException
- realmIds
is
null
mandatory
- This method must be implemented. void orderRealmResults(RealmSearchOrder realmSearchOrder)
realmSearchOrder
- realm search orderNullArgumentException
- realmSearchOrder
is null
UnsupportedException
- realmSearchOrder
is not of this servicemandatory
- This method must be implemented. RealmSearchRecord getRealmSearchRecord(Type realmSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object implementing
the requested record.realmSearchRecordType
- a realm search record typeNullArgumentException
- realmSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(realmSearchRecordType)
is false
mandatory
- This method must be implemented.