public interface SystemQuerySession extends OsidSession
This session provides methods for searching among System
objects. The search query is constructed using the SystemQuery.
Systems may have a query record indicated by their respective record
types. The query record is accessed via the SystemQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchSystems()
Tests if this user can perform
System searches. |
SystemQuery |
getSystemQuery()
Gets a system query.
|
SystemList |
getSystemsByQuery(SystemQuery systemQuery)
Gets a list of
Systems matching the given system query. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchSystems()
System
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 not offer lookup operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. SystemQuery getSystemQuery()
mandatory
- This method must be implemented. SystemList getSystemsByQuery(SystemQuery systemQuery) throws OperationFailedException, PermissionDeniedException
Systems
matching the given system query.systemQuery
- the system query SystemList
NullArgumentException
- systemQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- systemQuery
is
not of this servicemandatory
- This method must be implemented.