public interface GraphQuerySession extends OsidSession
This session provides methods for searching among Graph
objects. The search query is constructed using the GraphQuery.
Graphs may have a query record indicated by their respective record
types. The query record is accessed via the GraphQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchGraphs()
Tests if this user can perform
Graph searches. |
GraphQuery |
getGraphQuery()
Gets a graph query.
|
GraphList |
getGraphsByQuery(GraphQuery graphQuery)
Gets a list of
Graphs matching the given graph query. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchGraphs()
Graph
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. GraphQuery getGraphQuery()
mandatory
- This method must be implemented. GraphList getGraphsByQuery(GraphQuery graphQuery) throws OperationFailedException, PermissionDeniedException
Graphs
matching the given graph query.graphQuery
- the graph query GraphList
NullArgumentException
- graphQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- graphQuery
is not
of this servicemandatory
- This method must be implemented.