org.osid.topology

Interface NodeGraphSession

All Superinterfaces:

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

public interface NodeGraphSession
extends OsidSession

This session provides methods to retrieve Node to Graph mappings. A Node may appear in multiple Graph objects. Each graph may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupNodeGraphMappings() Tests if this user can perform lookups of node/graph mappings.
IdList	getGraphIdsByNode(Id nodeId) Gets the Graph Ids mapped to a Node.
GraphList	getGraphsByNode(Id nodeId) Gets the Graphs mapped to a Node.
IdList	getNodeIdsByGraph(Id graphId) Gets the list of Node Ids associated with a Graph.
IdList	getNodeIdsByGraphs(IdList graphIds) Gets the list of Node Ids corresponding to a list of Graphs.
NodeList	getNodesByGraph(Id graphId) Gets the list of Nodes associated with a Graph.
NodeList	getNodesByGraphs(IdList graphIds) Gets the list of Nodes corresponding to a list of Graphs.
void	useComparativeNodeGraphView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryNodeGraphView() A complete view of the Node and Graph returns is desired.

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

canLookupNodeGraphMappings

boolean canLookupNodeGraphMappings()

Tests if this user can perform lookups of node/graph mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeNodeGraphView

void useComparativeNodeGraphView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryNodeGraphView

void usePlenaryNodeGraphView()

A complete view of the Node and Graph returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getNodeIdsByGraph

IdList getNodeIdsByGraph(Id graphId)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Gets the list of Node Ids associated with a Graph.

Parameters:

graphId - Id of the Graph

Returns:

list of related node Ids

Throws:

NotFoundException - graphId is not found

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getNodesByGraph

NodeList getNodesByGraph(Id graphId)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Gets the list of Nodes associated with a Graph.

Parameters:

graphId - Id of the Graph

Returns:

list of related nodes

Throws:

NotFoundException - graphId is not found

NullArgumentException - graphId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getNodeIdsByGraphs

IdList getNodeIdsByGraphs(IdList graphIds)
                          throws OperationFailedException,
                                 PermissionDeniedException

Gets the list of Node Ids corresponding to a list of Graphs.

Parameters:

graphIds - list of graph Ids

Returns:

list of node Ids

Throws:

NullArgumentException - graphIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getNodesByGraphs

NodeList getNodesByGraphs(IdList graphIds)
                          throws OperationFailedException,
                                 PermissionDeniedException

Gets the list of Nodes corresponding to a list of Graphs.

Parameters:

graphIds - list of graph Ids

Returns:

list of nodes

Throws:

NullArgumentException - graphIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGraphIdsByNode

IdList getGraphIdsByNode(Id nodeId)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Gets the Graph Ids mapped to a Node.

Parameters:

nodeId - Id of a Node

Returns:

list of graphs

Throws:

NotFoundException - nodeId is not found

NullArgumentException - nodeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGraphsByNode

GraphList getGraphsByNode(Id nodeId)
                          throws NotFoundException,
                                 OperationFailedException,
                                 PermissionDeniedException

Gets the Graphs mapped to a Node.

Parameters:

nodeId - Id of a Node

Returns:

list of graphs

Throws:

NotFoundException - nodeId is not found

NullArgumentException - nodeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.