OSID - osid.personnel.RealmQuerySession Service Interface Definition

Interface	osid.personnel.RealmQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.personnel.RealmSearchSession`
Used By	`osid.personnel.PersonnelManager`
Used By	`osid.personnel.PersonnelProxyManager`
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.
Method	canSearchRealms
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.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRealmQuery
Description	Gets a realm query.
Return	`osid.personnel.RealmQuery`		the realm query
Compliance	`mandatory`		This method must be implemented.
Method	getRealmsByQuery
Description	Gets a list of `Realms` matching the given search.
Parameters	`osid.personnel.RealmQuery`	`realmQuery`	the realm query
Return	`osid.personnel.RealmList`		the returned `RealmList`
Errors	NULL_ARGUMENT		`realmQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`realmQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.