org.osid.personnel

Interface RealmQuerySession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

All Known Subinterfaces:

RealmSearchSession

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canSearchRealms

boolean canSearchRealms()

Tests if this user can perform 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.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getRealmQuery

RealmQuery getRealmQuery()

Gets a realm query.

Returns:

the realm query

Compliance:

mandatory - This method must be implemented.

getRealmsByQuery

RealmList getRealmsByQuery(RealmQuery realmQuery)
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets a list of Realms matching the given search.

Parameters:

realmQuery - the realm query

Returns:

the returned RealmList

Throws:

NullArgumentException - realmQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - realmQuery is not of this service

Compliance:

mandatory - This method must be implemented.