Interface EdgeSmartGraphSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

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 .

Method Summary

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

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 Graph 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.

getEdgeQuery

EdgeQuery getEdgeQuery()

Gets an edge query.

Returns:

the edge query

Compliance:

mandatory - This method must be implemented.

getEdgeSearchOrder

EdgeSearchOrder getEdgeSearchOrder()

Gets an edge search order.

Returns:

the edge search order

Compliance:

mandatory - This method must be implemented.

applyEdgeQuery

void applyEdgeQuery(EdgeQuery edgeQuery)
             throws OperationFailedException,
PermissionDeniedException

Applies an edge query to this graph.

Parameters:

edgeQuery - the edge query

Throws:

NullArgumentException - edgeQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - edgeQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectEdgeQuery

EdgeQueryInspector inspectEdgeQuery()
                             throws OperationFailedException,
PermissionDeniedException

Gets an edge query inspector for this graph.

Returns:

the edge query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyEdgeSequencing

void applyEdgeSequencing(EdgeSearchOrder edgeSearchOrder)
                  throws OperationFailedException,
PermissionDeniedException

Applies an edge search order to this graph.

Parameters:

edgeSearchOrder - the edge search order

Throws:

NullArgumentException - edgeSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - edgeSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getEdgeQueryFromInspector

EdgeQuery getEdgeQueryFromInspector(EdgeQueryInspector edgeQueryInspector)

Gets an edge query from an inspector.

Parameters:

edgeQueryInspector - an edge query inspector

Returns:

the edge query

Throws:

NullArgumentException - relatinshipQueryInspector is null

UnsupportedException - edgeQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.