Interface | osid.topology.rules.EdgeEnablerGraphSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupEdgeEnablerGraphMappings | ||
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 | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeEdgeEnablerGraphView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryEdgeEnablerGraphView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getEdgeEnablerIdsByGraph | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | graphId | Id of the Graph |
Return | osid.id.IdList | list of related edge enabler Ids | |
Errors | NOT_FOUND | graphId is not found | |
NULL_ARGUMENT | graphId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEdgeEnablersByGraph | ||
Description |
Gets the list of edge enablers associated with a | ||
Parameters | osid.id.Id | graphId | Id of the Graph |
Return | osid.topology.rules.EdgeEnablerList | list of related edge enablers | |
Errors | NOT_FOUND | graphId is not found | |
NULL_ARGUMENT | graphId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEdgeEnablerIdsByOntologies | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | graphIds | list of graph Ids |
Return | osid.id.IdList | list of edge enabler Ids | |
Errors | NULL_ARGUMENT | graphIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEdgeEnablersByOntologies | ||
Description |
Gets the list of edge enablers corresponding to a list
of | ||
Parameters | osid.id.IdList | graphIds | list of graph Ids |
Return | osid.topology.rules.EdgeEnablerList | list of edge enablers | |
Errors | NULL_ARGUMENT | graphIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getGraphIdsByEdgeEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | edgeEnablerId | Id of an EdgeEnabler |
Return | osid.id.IdList | list of ontologies | |
Errors | NOT_FOUND | edgeEnablerId is not found | |
NULL_ARGUMENT | edgeEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOntologiesByEdgeEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | edgeEnablerId | Id of an EdgeEnabler |
Return | osid.topology.GraphList | list of ontologies | |
Errors | NOT_FOUND | edgeEnablerId is not found | |
NULL_ARGUMENT | edgeEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |