OSID Logo
OSID Specifications
topology rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.rules.EdgeEnablerGraphSession
Implementsosid.OsidSession
Description

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
MethodcanLookupEdgeEnablerGraphMappings
Description

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.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeEdgeEnablerGraphView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryEdgeEnablerGraphView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethodgetEdgeEnablerIdsByGraph
Description

Gets the list of EdgeEnablerIds associated with a Graph.

Parametersosid.id.IdgraphId Id of the Graph
Returnosid.id.IdListlist of related edge enabler Ids
ErrorsNOT_FOUND graphId is not found
NULL_ARGUMENT graphId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEdgeEnablersByGraph
Description

Gets the list of edge enablers associated with a Graph.

Parametersosid.id.IdgraphId Id of the Graph
Returnosid.topology.rules.EdgeEnablerListlist of related edge enablers
ErrorsNOT_FOUND graphId is not found
NULL_ARGUMENT graphId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEdgeEnablerIdsByOntologies
Description

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

Parametersosid.id.IdListgraphIdslist of graph Ids
Returnosid.id.IdListlist of edge enabler Ids
ErrorsNULL_ARGUMENT graphIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEdgeEnablersByOntologies
Description

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

Parametersosid.id.IdListgraphIdslist of graph Ids
Returnosid.topology.rules.EdgeEnablerListlist of edge enablers
ErrorsNULL_ARGUMENT graphIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetGraphIdsByEdgeEnabler
Description

Gets the Graph Ids mapped to an EdgeEnabler.

Parametersosid.id.IdedgeEnablerId Id of an EdgeEnabler
Returnosid.id.IdListlist of ontologies
ErrorsNOT_FOUND edgeEnablerId is not found
NULL_ARGUMENT edgeEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOntologiesByEdgeEnabler
Description

Gets the Ontologies mapped to an EdgeEnabler.

Parametersosid.id.IdedgeEnablerId Id of an EdgeEnabler
Returnosid.topology.GraphListlist of ontologies
ErrorsNOT_FOUND edgeEnablerId is not found
NULL_ARGUMENT edgeEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.