Interface EdgeGraphSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface EdgeGraphSession
extends OsidSession

This session provides methods to retrieve Edge to Graph mappings. An Edge 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

Modifier and Type	Method	Description
boolean	canLookupEdgeGraphMappings()	Tests if this user can perform lookups of edge/graph mappings.
IdList	getEdgeIdsByGraph(Id graphId)	Gets the list of Edge Ids associated with a Graph .
IdList	getEdgeIdsByGraphs(IdList graphIds)	Gets the list of Edge Ids corresponding to a list of Graphs .
EdgeList	getEdgesByGraph(Id graphId)	Gets the list of Edges associated with a Graph .
EdgeList	getEdgesByGraphs(IdList graphIds)	Gets the list of Edge corresponding to a list of Graphs .
IdList	getGraphIdsByEdge(Id edgeId)	Gets the Graph Ids mapped to an Edge .
GraphList	getGraphsByEdge(Id edgeId)	Gets the Graphs mapped to an Edge .
void	useComparativeEdgeGraphView()	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	usePlenaryEdgeGraphView()	A complete view of the Edge and Graph returns is desired.

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

canLookupEdgeGraphMappings

boolean canLookupEdgeGraphMappings()

Tests if this user can perform lookups of edge/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.

useComparativeEdgeGraphView

void useComparativeEdgeGraphView()

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.

usePlenaryEdgeGraphView

void usePlenaryEdgeGraphView()

A complete view of the Edge 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.

getEdgeIdsByGraph

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

Gets the list of Edge Ids associated with a Graph .

Parameters:

graphId - Id of the Graph

Returns:

list of related edge 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.

getEdgesByGraph

EdgeList getEdgesByGraph(Id graphId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Edges associated with a Graph .

Parameters:

graphId - Id of the Graph

Returns:

list of related edges

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.

getEdgeIdsByGraphs

IdList getEdgeIdsByGraphs(IdList graphIds)
                   throws OperationFailedException,
PermissionDeniedException

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

Parameters:

graphIds - list of graph Ids

Returns:

list of edge Ids

Throws:

NullArgumentException - graphIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEdgesByGraphs

EdgeList getEdgesByGraphs(IdList graphIds)
                   throws OperationFailedException,
PermissionDeniedException

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

Parameters:

graphIds - list of graph Ids

Returns:

list of edge

Throws:

NullArgumentException - graphIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGraphIdsByEdge

IdList getGraphIdsByEdge(Id edgeId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Graph Ids mapped to an Edge .

Parameters:

edgeId - Id of an Edge

Returns:

list of graphs

Throws:

NotFoundException - edgeId is not found

NullArgumentException - edgeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGraphsByEdge

GraphList getGraphsByEdge(Id edgeId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Graphs mapped to an Edge .

Parameters:

edgeId - Id of an Edge

Returns:

list of graphs

Throws:

NotFoundException - edgeId is not found

NullArgumentException - edgeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.