public interface NodeSmartGraphSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A NodeQuery
can be retrieved from this session
and mapped to this Graph
to create a virtual collection of
Nodes.
The entries may be sequenced using the
NodeSearchOrder
from this session.
This Graph
has a default query that matches any node
and a default search order that specifies no sequencing. The queries may
be examined using a NodeQueryInspector.
The query may be
modified by converting the inspector back to a NodeQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyNodeQuery(NodeQuery nodeQuery)
Applies a node query to this graph.
|
void |
applyNodeSequencing(NodeSearchOrder nodeSearchOrder)
Applies a node search order to this graph.
|
boolean |
canManageSmartGraphs()
Tests if this user can manage smart graphs.
|
Graph |
getGraph()
Gets the
Graph associated with this session. |
Id |
getGraphId()
Gets the
Familt Id associated with this
session. |
NodeQuery |
getNodeQuery()
Gets a node query.
|
NodeQuery |
getNodeQueryFromInspector(NodeQueryInspector nodeQueryInspector)
Gets a node query from an inspector.
|
NodeSearchOrder |
getNodeSearchOrder()
Gets a node search order.
|
NodeQueryInspector |
inspectNodeQuery()
Gets a node query inspector for this graph.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getGraphId()
Familt
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. NodeQuery getNodeQuery()
mandatory
- This method must be implemented. NodeSearchOrder getNodeSearchOrder()
mandatory
- This method must be implemented. void applyNodeQuery(NodeQuery nodeQuery) throws OperationFailedException, PermissionDeniedException
nodeQuery
- the node queryNullArgumentException
- nodeQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- nodeQuery
not of
this servicemandatory
- This method must be implemented. NodeQueryInspector inspectNodeQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyNodeSequencing(NodeSearchOrder nodeSearchOrder) throws OperationFailedException, PermissionDeniedException
nodeSearchOrder
- the node search orderNullArgumentException
- nodeSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- nodeSearchOrder
not of this servicemandatory
- This method must be implemented. NodeQuery getNodeQueryFromInspector(NodeQueryInspector nodeQueryInspector)
nodeQueryInspector
- a node query inspectorNullArgumentException
-
relatinshipQueryInspector
is null
UnsupportedException
- nodeQueryInspector
is not of this servicemandatory
- This method must be implemented.