Interface NodeSmartGraphSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

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 .

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getGraphId

Id getGraphId()

Gets the Familt Id associated with this session.

Returns:

the Graph Id associated with this session

Compliance:

mandatory - This method must be implemented.

getGraph

Graph getGraph()
        throws OperationFailedException,
PermissionDeniedException

Gets the Graph associated with this session.

Returns:

the graph

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartGraphs

boolean canManageSmartGraphs()

Tests if this user can manage smart graphs. 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 opt not to offer smart operations.

Returns:

false if smart graph methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getNodeQuery

NodeQuery getNodeQuery()

Gets a node query.

Returns:

the node query

Compliance:

mandatory - This method must be implemented.

getNodeSearchOrder

NodeSearchOrder getNodeSearchOrder()

Gets a node search order.

Returns:

the node search order

Compliance:

mandatory - This method must be implemented.

applyNodeQuery

void applyNodeQuery(NodeQuery nodeQuery)
             throws OperationFailedException,
PermissionDeniedException

Applies a node query to this graph.

Parameters:

nodeQuery - the node query

Throws:

NullArgumentException - nodeQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - nodeQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectNodeQuery

NodeQueryInspector inspectNodeQuery()
                             throws OperationFailedException,
PermissionDeniedException

Gets a node query inspector for this graph.

Returns:

the node query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyNodeSequencing

void applyNodeSequencing(NodeSearchOrder nodeSearchOrder)
                  throws OperationFailedException,
PermissionDeniedException

Applies a node search order to this graph.

Parameters:

nodeSearchOrder - the node search order

Throws:

NullArgumentException - nodeSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - nodeSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getNodeQueryFromInspector

NodeQuery getNodeQueryFromInspector(NodeQueryInspector nodeQueryInspector)

Gets a node query from an inspector.

Parameters:

nodeQueryInspector - a node query inspector

Returns:

the node query

Throws:

NullArgumentException - relatinshipQueryInspector is null

UnsupportedException - nodeQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.