public interface EdgeQuerySession extends OsidSession
This session provides methods for searching among Edge
objects. The search query is constructed using the EdgeQuery.
This session defines views that offer differing behaviors for searching.
Edges may have a query record indicated by their respective record
types. The query record is accessed via the EdgeQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchEdges()
Tests if this user can perform
Edge lookups. |
EdgeQuery |
getEdgeQuery()
Gets an edge query.
|
EdgeList |
getEdgesByQuery(EdgeQuery edgeQuery)
Gets a list of
Edges matching the given edge query. |
Graph |
getGraph()
Gets the
Graph associated with this session. |
Id |
getGraphId()
Gets the
Graph Id associated with this
session. |
void |
useFederatedGraphView()
Federates the view for methods in this session.
|
void |
useIsolatedGraphView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getGraphId()
Graph
Id
associated with this
session. Graph Id
associated with this sessionmandatory
- This method must be implemented. Graph getGraph() throws OperationFailedException, PermissionDeniedException
Graph
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchEdges()
Edge
lookups. 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. void useFederatedGraphView()
mandatory
- This method is must be implemented. void useIsolatedGraphView()
mandatory
- This method is must be implemented. EdgeQuery getEdgeQuery()
mandatory
- This method must be implemented. EdgeList getEdgesByQuery(EdgeQuery edgeQuery) throws OperationFailedException, PermissionDeniedException
Edges
matching the given edge query.edgeQuery
- the edge query EdgeList
NullArgumentException
- edgeQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- edgeQuery
is not
of this servicemandatory
- This method must be implemented.