public interface EdgeSmartGraphSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An EdgeQuery
can be retrieved from this session
and mapped to this Graph
to create a virtual collection of
Edges.
The entries may be sequenced using the
EdgeSearchOrder
from this session.
This Graph
has a default query that matches any edge
and a default search order that specifies no sequencing. The queries may
be examined using an EdgeQueryInspector.
The query may be
modified by converting the inspector back to an EdgeQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyEdgeQuery(EdgeQuery edgeQuery)
Applies an edge query to this graph.
|
void |
applyEdgeSequencing(EdgeSearchOrder edgeSearchOrder)
Applies an edge search order to this graph.
|
boolean |
canManageSmartGraphs()
Tests if this user can manage smart graphs.
|
EdgeQuery |
getEdgeQuery()
Gets an edge query.
|
EdgeQuery |
getEdgeQueryFromInspector(EdgeQueryInspector edgeQueryInspector)
Gets an edge query from an inspector.
|
EdgeSearchOrder |
getEdgeSearchOrder()
Gets an edge search order.
|
Graph |
getGraph()
Gets the
Graph associated with this session. |
Id |
getGraphId()
Gets the
Graph Id associated with this
session. |
EdgeQueryInspector |
inspectEdgeQuery()
Gets an edge query inspector for this graph.
|
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 canManageSmartGraphs()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer smart operations. false
if smart graph methods are not
authorized, true
otherwisemandatory
- This method must be implemented. EdgeQuery getEdgeQuery()
mandatory
- This method must be implemented. EdgeSearchOrder getEdgeSearchOrder()
mandatory
- This method must be implemented. void applyEdgeQuery(EdgeQuery edgeQuery) throws OperationFailedException, PermissionDeniedException
edgeQuery
- the edge queryNullArgumentException
- edgeQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- edgeQuery
not of
this servicemandatory
- This method must be implemented. EdgeQueryInspector inspectEdgeQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyEdgeSequencing(EdgeSearchOrder edgeSearchOrder) throws OperationFailedException, PermissionDeniedException
edgeSearchOrder
- the edge search orderNullArgumentException
- edgeSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- edgeSearchOrder
not of this servicemandatory
- This method must be implemented. EdgeQuery getEdgeQueryFromInspector(EdgeQueryInspector edgeQueryInspector)
edgeQueryInspector
- an edge query inspectorNullArgumentException
-
relatinshipQueryInspector
is null
UnsupportedException
- edgeQueryInspector
is not of this servicemandatory
- This method must be implemented.