Interface | osid.topology.EdgeLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most
applications as it permits operation even if there is data
that cannot be accessed. The methods | ||
Method | getGraphId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Graph Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getGraph | ||
Description |
Gets the | ||
Return | osid.topology.Graph | the graph | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupEdges | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeEdgeView | ||
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 | usePlenaryEdgeView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedGraphView | ||
Description |
Federates the view for methods in this session. A federated view will include edges in graphs which are children of this graph in the graph hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedGraphView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this graph only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useEffectiveEdgeView | ||
Description |
Only edges whose effective dates are current are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyEffectiveEdgeView | ||
Description |
All edges of any effective dates are returned by all methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getEdge | ||
Description |
Gets the In effective mode, edges are returned that are currently effective. In any effective mode, effective edges and those currently expired are returned. | ||
Parameters | osid.id.Id | edgeId | Id of the Edge |
Return | osid.topology.Edge | the edge | |
Errors | NOT_FOUND | edgeId not found | |
NULL_ARGUMENT | edgeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getEdgesByIds | ||
Description |
Gets an In effective mode, edges are returned that are currently effective. In any effective mode, effective edges and those currently expired are returned. | ||
Parameters | osid.id.IdList | edgeIds | the list of Ids to retrieve |
Return | osid.topology.EdgeList | the returned Edge list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | edgeIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEdgesByGenusType | ||
Description |
Gets an In effective mode, edges are returned that are currently effective. In any effective mode, effective edges and those currently expired are returned. | ||
Parameters | osid.type.Type | edgeGenusType | an edge genus type |
Return | osid.topology.EdgeList | the returned Edge list | |
Errors | NULL_ARGUMENT | edgeGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEdgesByParentGenusType | ||
Description |
Gets an In effective mode, edges are returned that are currently effective. In any effective mode, effective edges and those currently expired are returned. | ||
Parameters | osid.type.Type | edgeGenusType | an edge genus type |
Return | osid.topology.EdgeList | the returned Edge list | |
Errors | NULL_ARGUMENT | edgeGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEdgesByRecordType | ||
Description |
Gets an In effective mode, edges are returned that are currently effective. In any effective mode, effective edges and those currently expired are returned. | ||
Parameters | osid.type.Type | edgeRecordType | an edge record type |
Return | osid.topology.EdgeList | the returned Edge list | |
Errors | NULL_ARGUMENT | edgeRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEdgesOnDate | ||
Description |
Gets an In effective mode, edges are returned that are currently effective. In any effective mode, effective edges and those currently expired are returned. | ||
Parameters | osid.calendaring.DateTime | from | starting date |
osid.calendaring.DateTime | to | ending date | |
Return | osid.topology.EdgeList | the returned Edge list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEdgesByGenusTypeOnDate | ||
Description |
Gets an In effective mode, edges are returned that are currently effective. In any effective mode, effective edges and those currently expired are returned. | ||
Parameters | osid.type.Type | edgeGenusType | an edge genus type |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.topology.EdgeList | the returned Edge list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | edgeGenusType, from, or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEdgesForSourceNode | ||
Description |
Gets an In effective mode, edges are returned that are currently effective. In any effective mode, effective edges and those currently expired are returned. | ||
Parameters | osid.id.Id | sourceNodeId | a node Id |
Return | osid.topology.EdgeList | a list of edges | |
Errors | NULL_ARGUMENT | sourceNodeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEdgesForSourceNodeOnDate | ||
Description |
Gets an In effective mode, edges are returned that are currently effective. In any effective mode, effective edges and those currently expired are returned. | ||
Parameters | osid.id.Id | sourceNodeId | a node Id |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.topology.EdgeList | a list of edges | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | sourceNodeId, from or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEdgesByGenusTypeForSourceNode | ||
Description |
Gets an In plenary mode, the returned list contains all of the
edges corresponding to the given peer, including
duplicates, or an error results if an edge is
inaccessible. Otherwise, inaccessible In effective mode, edges are returned that are currently effective. In any effective mode, effective edges and those currently expired are returned. | ||
Parameters | osid.id.Id | sourceNodeId | a node Id |
osid.type.Type | edgeGenusType | an edge genus type | |
Return | osid.topology.EdgeList | a list of edges | |
Errors | NULL_ARGUMENT | sourceNodeId or edgeGenusType is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEdgesByGenusTypeForSourceNodeOnDate | ||
Description |
Gets an In effective mode, edges are returned that are currently effective. In any effective mode, effective edges and those currently expired are returned. | ||
Parameters | osid.id.Id | nodeId | a node Id |
osid.type.Type | edgeGenusType | an edge genus type | |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.topology.EdgeList | a list of edges | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | sourceNodeId, edgeGenusType, from or to is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEdgesForDestinationNode | ||
Description |
Gets an In effective mode, edges are returned that are currently effective. In any effective mode, effective edges and those currently expired are returned. | ||
Parameters | osid.id.Id | destinationNodeId | a node Id |
Return | osid.topology.EdgeList | a list of edges | |
Errors | NULL_ARGUMENT | destinationNodeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEdgesForDestinationNodeOnDate | ||
Description |
Gets an In effective mode, edges are returned that are currently effective. In any effective mode, effective edges and those currently expired are returned. | ||
Parameters | osid.id.Id | destinationNodeId | a node Id |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.topology.EdgeList | a list of edges | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | destinationNodeId, from or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEdgesByGenusTypeForDestinationNode | ||
Description |
Gets an In plenary mode, the returned list contains all of the
edges corresponding to the given peer, including
duplicates, or an error results if an edge is
inaccessible. Otherwise, inaccessible In effective mode, edges are returned that are currently effective. In any effective mode, effective edges and those currently expired are returned. | ||
Parameters | osid.id.Id | destinationNodeId | a node Id |
osid.type.Type | edgeGenusType | an edge genus type | |
Return | osid.topology.EdgeList | a list of edges | |
Errors | NULL_ARGUMENT | destinationNodeId or edgeGenusType is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEdgesByGenusTypeForDestinationNodeOnDate | ||
Description |
Gets an In effective mode, edges are returned that are currently effective. In any effective mode, effective edges and those currently expired are returned. | ||
Parameters | osid.id.Id | destinationNodeId | a node Id |
osid.type.Type | edgeGenusType | an edge genus type | |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.topology.EdgeList | a list of edges | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | destinationNodeId, edgeGenusType, from or to
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEdgesForNodes | ||
Description |
Gets an EdgeList corresponding to the given node In effective mode, edges are returned that are currently effective. In any effective mode, effective edges and those currently expired are returned. | ||
Parameters | osid.id.Id | sourceNodeId | a node Id |
osid.id.Id | destinationNodeId | a node Id | |
Return | osid.topology.EdgeList | a list of edges | |
Errors | NULL_ARGUMENT | sourceNodeId or destinationNodeId is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEdgesForNodesOnDate | ||
Description |
Gets an In effective mode, edges are returned that are currently effective. In any effective mode, effective edges and those currently expired are returned. | ||
Parameters | osid.id.Id | sourceNodeId | a node Id |
osid.id.Id | destinationNodeId | a node Id | |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.topology.EdgeList | a list of edges | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | sourceNodeId, destinationNodeId, from or to
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEdgesByGenusTypeForNodes | ||
Description |
Gets an EdgeList corresponding to the given peer In effective mode, edges are returned that are currently effective. In any effective mode, effective edges and those currently expired are returned. | ||
Parameters | osid.id.Id | sourceNodeId | a node Id |
osid.id.Id | destinationNodeId | a node Id | |
osid.type.Type | edgeGenusType | an edge genus type | |
Return | osid.topology.EdgeList | the edges | |
Errors | NULL_ARGUMENT | sourceNodeId, destinationNodeId, or edgeGenusType
is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEdgesByGenusTypeForNodesOnDate | ||
Description |
Gets an In effective mode, edges are returned that are currently effective. In any effective mode, effective edges and those currently expired are returned. | ||
Parameters | osid.id.Id | sourceNodeId | a node Id |
osid.id.Id | destinationNodeId | a node Id | |
osid.type.Type | edgeGenusType | an edge genus type | |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.topology.EdgeList | a list of edges | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | sourceNodeId, destinationNodeId, edgeGenusType, from or
to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEdges | ||
Description |
Gets all In plenary mode, the returned list contains all known edges or an error results. Otherwise, the returned list may contain only those edges that are accessible through this session. In effective mode, edges are returned that are currently effective. In any effective mode, effective edges and those currently expired are returned. | ||
Return | osid.topology.EdgeList | a list of Edges | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |