OSID Logo
OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.RealmQuerySession
Implementsosid.OsidSession
Description

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.

MethodcanSearchRealms
Description

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.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRealmQuery
Description

Gets a realm query.

Returnosid.personnel.RealmQuerythe realm query
CompliancemandatoryThis method must be implemented.
MethodgetRealmsByQuery
Description

Gets a list of Realms matching the given search.

Parametersosid.personnel.RealmQueryrealmQuerythe realm query
Returnosid.personnel.RealmListthe returned RealmList
ErrorsNULL_ARGUMENT realmQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED realmQuery is not of this service
CompliancemandatoryThis method must be implemented.