public interface EdgeEnablerQuerySession extends OsidSession
This session provides methods for searching among EdgeEnabler
objects. The search query is constructed using the
EdgeEnablerQuery.
This session defines views that offer differing behaviors for searching.
Edge enablers may have a query record indicated by their respective
record types. The query record is accessed via the
EdgeEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchEdgeEnablers()
Tests if this user can perform
EdgeEnabler lookups. |
EdgeEnablerQuery |
getEdgeEnablerQuery()
Gets an edge enabler query.
|
EdgeEnablerList |
getEdgeEnablersByQuery(EdgeEnablerQuery edgeEnablerQuery)
Gets a list of
EdgeEnablers matching the given edge
enabler 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 canSearchEdgeEnablers()
EdgeEnabler
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. EdgeEnablerQuery getEdgeEnablerQuery()
mandatory
- This method must be implemented. EdgeEnablerList getEdgeEnablersByQuery(EdgeEnablerQuery edgeEnablerQuery) throws OperationFailedException, PermissionDeniedException
EdgeEnablers
matching the given edge
enabler query.edgeEnablerQuery
- the edge enabler query query EdgeEnablerList
NullArgumentException
- edgeEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- edgeEnablerQuery
is not of this servicemandatory
- This method must be implemented.