Interface EdgeEnablerGraphSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface EdgeEnablerGraphSession
extends OsidSession

This session provides methods to retrieve EdgeEnabler to Graph mappings. An EdgeEnabler 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	canLookupEdgeEnablerGraphMappings()	Tests if this user can perform lookups of edge enabler/graph mappings.
IdList	getEdgeEnablerIdsByGraph(Id graphId)	Gets the list of EdgeEnablerIds associated with a Graph .
IdList	getEdgeEnablerIdsByOntologies(IdList graphIds)	Gets the list of EdgeEnabler Ids corresponding to a list of Ontologies .
EdgeEnablerList	getEdgeEnablersByGraph(Id graphId)	Gets the list of edge enablers associated with a Graph .
EdgeEnablerList	getEdgeEnablersByOntologies(IdList graphIds)	Gets the list of edge enablers corresponding to a list of Ontologies .
IdList	getGraphIdsByEdgeEnabler(Id edgeEnablerId)	Gets the Graph Ids mapped to an EdgeEnabler .
GraphList	getOntologiesByEdgeEnabler(Id edgeEnablerId)	Gets the Ontologies mapped to an EdgeEnabler .
void	useComparativeEdgeEnablerGraphView()	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	usePlenaryEdgeEnablerGraphView()	A complete view of the EdgeEnabler 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

canLookupEdgeEnablerGraphMappings

boolean canLookupEdgeEnablerGraphMappings()

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

useComparativeEdgeEnablerGraphView

void useComparativeEdgeEnablerGraphView()

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.

usePlenaryEdgeEnablerGraphView

void usePlenaryEdgeEnablerGraphView()

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

getEdgeEnablerIdsByGraph

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

Gets the list of EdgeEnablerIds associated with a Graph .

Parameters:

graphId - Id of the Graph

Returns:

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

getEdgeEnablersByGraph

EdgeEnablerList getEdgeEnablersByGraph(Id graphId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of edge enablers associated with a Graph .

Parameters:

graphId - Id of the Graph

Returns:

list of related edge enablers

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.

getEdgeEnablerIdsByOntologies

IdList getEdgeEnablerIdsByOntologies(IdList graphIds)
                              throws OperationFailedException,
PermissionDeniedException

Gets the list of EdgeEnabler Ids corresponding to a list of Ontologies .

Parameters:

graphIds - list of graph Ids

Returns:

list of edge enabler Ids

Throws:

NullArgumentException - graphIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEdgeEnablersByOntologies

EdgeEnablerList getEdgeEnablersByOntologies(IdList graphIds)
                                     throws OperationFailedException,
PermissionDeniedException

Gets the list of edge enablers corresponding to a list of Ontologies .

Parameters:

graphIds - list of graph Ids

Returns:

list of edge enablers

Throws:

NullArgumentException - graphIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getGraphIdsByEdgeEnabler

IdList getGraphIdsByEdgeEnabler(Id edgeEnablerId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Graph Ids mapped to an EdgeEnabler .

Parameters:

edgeEnablerId - Id of an EdgeEnabler

Returns:

list of ontologies

Throws:

NotFoundException - edgeEnablerId is not found

NullArgumentException - edgeEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOntologiesByEdgeEnabler

GraphList getOntologiesByEdgeEnabler(Id edgeEnablerId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Ontologies mapped to an EdgeEnabler .

Parameters:

edgeEnablerId - Id of an EdgeEnabler

Returns:

list of ontologies

Throws:

NotFoundException - edgeEnablerId is not found

NullArgumentException - edgeEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.