public interface RealmQuerySession extends OsidSession
This session provides methods for querying Realm
objects. The search query is constructed using the RealmQuery.
Realms may have a query record indicated by their respective record
types. The query record is accessed via the RealmQuery.
The
returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchRealms()
Tests if this user can perform
Realm searches. |
RealmQuery |
getRealmQuery()
Gets a realm query.
|
RealmList |
getRealmsByQuery(RealmQuery realmQuery)
Gets a list of
Realms matching the given search. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchRealms()
Realm
searches. A return
of true does not guarantee successful authorization. A return of false
indicates that it is known all methods in this session will result in
a PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. RealmQuery getRealmQuery()
mandatory
- This method must be implemented. RealmList getRealmsByQuery(RealmQuery realmQuery) throws OperationFailedException, PermissionDeniedException
Realms
matching the given search.realmQuery
- the realm query RealmList
NullArgumentException
- realmQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- realmQuery
is not
of this servicemandatory
- This method must be implemented.