org.osid.topology.rules

Interface EdgeEnablerSmartGraphSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface EdgeEnablerSmartGraphSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic ontologies. An EdgeEnablerQuery can be retrieved from this session and mapped to this Graph to create a virtual collection of edge enablers. The edge enablers may be sequenced using the EdgeEnablerSearchOrder from this session.

This Graph has a default query that matches any edge enabler and a default search order that specifies no sequencing. The queries may be examined using an EdgeEnablerQueryInspector. The query may be modified by converting the inspector back to an EdgeEnablerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyEdgeEnablerQuery(EdgeEnablerQuery edgeEnablerQuery) Applies an edge enabler query to this graph.
void	applyEdgeEnablerSequencing(EdgeEnablerSearchOrder edgeEnablerSearchOrder) Applies an edge enabler search order to this graph.
boolean	canManageSmartOntologies() Tests if this user can manage smart ontologies.
EdgeEnablerQuery	getEdgeEnablerQuery() Gets an edge enabler query.
EdgeEnablerQuery	getEdgeEnablerQueryFromInspector(EdgeEnablerQueryInspector edgeEnablerQueryInspector) Gets an edge enabler query from an inspector.
EdgeEnablerSearchOrder	getEdgeEnablerSearchOrder() Gets an edge enabler search order.
Graph	getGraph() Gets the Graph associated with this session.
Id	getGraphId() Gets the Graph Id associated with this session.
EdgeEnablerQueryInspector	inspectEdgeEnablerQuery() Gets an edge enabler query inspector for this graph.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.

canManageSmartOntologies

boolean canManageSmartOntologies()

Tests if this user can manage smart ontologies. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returns:

false if smart graph management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getEdgeEnablerQuery

EdgeEnablerQuery getEdgeEnablerQuery()

Gets an edge enabler query.

Returns:

the edge enabler query

Compliance:

mandatory - This method must be implemented.

getEdgeEnablerSearchOrder

EdgeEnablerSearchOrder getEdgeEnablerSearchOrder()

Gets an edge enabler search order.

Returns:

the edge enabler search order

Compliance:

mandatory - This method must be implemented.

applyEdgeEnablerQuery

void applyEdgeEnablerQuery(EdgeEnablerQuery edgeEnablerQuery)
                           throws OperationFailedException,
                                  PermissionDeniedException

Applies an edge enabler query to this graph.

Parameters:

edgeEnablerQuery - the edge enabler query

Throws:

NullArgumentException - edgeEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - edgeEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectEdgeEnablerQuery

EdgeEnablerQueryInspector inspectEdgeEnablerQuery()
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Gets an edge enabler query inspector for this graph.

Returns:

the edge enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyEdgeEnablerSequencing

void applyEdgeEnablerSequencing(EdgeEnablerSearchOrder edgeEnablerSearchOrder)
                                throws OperationFailedException,
                                       PermissionDeniedException

Applies an edge enabler search order to this graph.

Parameters:

edgeEnablerSearchOrder - the edge enabler search order

Throws:

NullArgumentException - edgeEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - edgeEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getEdgeEnablerQueryFromInspector

EdgeEnablerQuery getEdgeEnablerQueryFromInspector(EdgeEnablerQueryInspector edgeEnablerQueryInspector)

Gets an edge enabler query from an inspector.

Parameters:

edgeEnablerQueryInspector - an edge enabler query inspector

Returns:

the edge enabler query

Throws:

NullArgumentException - edgeEnablerQueryInspector is null

UnsupportedException - edgeEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.