Interface | osid.topology.path.PathLookupSession | ||
---|---|---|---|
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 | canLookupPaths | ||
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 | useComparativePathView | ||
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 | usePlenaryPathView | ||
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 paths 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 | useEffectivePathView | ||
Description |
Only paths whose effective dates are current are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyEffectivePathView | ||
Description |
All paths of any effective dates are returned by all methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getPath | ||
Description |
Gets the In effective mode, paths are returned that are currently effective. In any effective mode, effective paths and those currently expired are returned. | ||
Parameters | osid.id.Id | pathId | Id of the Path |
Return | osid.topology.path.Path | the path | |
Errors | NOT_FOUND | pathId not found | |
NULL_ARGUMENT | pathId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getPathsByIds | ||
Description |
Gets a In effective mode, paths are returned that are currently effective. In any effective mode, effective paths and those currently expired are returned. | ||
Parameters | osid.id.IdList | pathIds | the list of Ids to retrieve |
Return | osid.topology.path.PathList | the returned Path list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | pathIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPathsByGenusType | ||
Description |
Gets a In effective mode, paths are returned that are currently effective. In any effective mode, effective paths and those currently expired are returned. | ||
Parameters | osid.type.Type | pathGenusType | a path genus type |
Return | osid.topology.path.PathList | the returned Path list | |
Errors | NULL_ARGUMENT | pathGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPathsByParentGenusType | ||
Description |
Gets a In effective mode, paths are returned that are currently effective. In any effective mode, effective paths and those currently expired are returned. | ||
Parameters | osid.type.Type | pathGenusType | a path genus type |
Return | osid.topology.path.PathList | the returned Path list | |
Errors | NULL_ARGUMENT | pathGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPathsByRecordType | ||
Description |
Gets a In effective mode, paths are returned that are currently effective. In any effective mode, effective paths and those currently expired are returned. | ||
Parameters | osid.type.Type | pathRecordType | a path record type |
Return | osid.topology.path.PathList | the returned Path list | |
Errors | NULL_ARGUMENT | pathRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPathsOnDate | ||
Description |
Gets a In effective mode, paths are returned that are currently effective. In any effective mode, effective paths and those currently expired are returned. | ||
Parameters | osid.calendaring.DateTime | from | starting date |
osid.calendaring.DateTime | to | ending date | |
Return | osid.topology.path.PathList | the returned Path 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 | getPathsByGenusTypeOnDate | ||
Description |
Gets a In effective mode, paths are returned that are currently effective. In any effective mode, effective paths and those currently expired are returned. | ||
Parameters | osid.type.Type | pathGenusType | a path genus type |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.topology.path.PathList | the returned Path list | |
Errors | INVALID_ARGUMENT | edgeGenusType, 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 | getPathsForStartingNode | ||
Description |
Gets a In effective mode, paths are returned that are currently effective. In any effective mode, effective paths and those currently expired are returned. | ||
Parameters | osid.id.Id | nodeId | a node Id |
Return | osid.topology.path.PathList | the returned Path list | |
Errors | NULL_ARGUMENT | nodeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPathsForStartingNodeOnDate | ||
Description |
Gets a In effective mode, paths are returned that are currently effective. In any effective mode, effective paths and those currently expired are returned. | ||
Parameters | osid.id.Id | nodeId | a node Id |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.topology.path.PathList | the returned Path list | |
Errors | INVALID_ARGUMENT | from Is greater than to | |
NULL_ARGUMENT | nodeId, from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPathsByGenusTypeForStartingNode | ||
Description |
Gets a In effective mode, paths are returned that are currently effective. In any effective mode, effective paths and those currently expired are returned. | ||
Parameters | osid.id.Id | nodeId | a node Id |
osid.type.Type | pathGenusType | a path genus type | |
Return | osid.topology.path.PathList | the returned Path list | |
Errors | NULL_ARGUMENT | nodeId is or pathGenusType null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPathsByGenusTypeForStartingNodeOnDate | ||
Description |
Gets a In effective mode, paths are returned that are currently effective. In any effective mode, effective paths and those currently expired are returned. | ||
Parameters | osid.id.Id | nodeId | a node Id |
osid.type.Type | pathGenusType | a path genus type | |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.topology.path.PathList | the returned Path list | |
Errors | INVALID_ARGUMENT | from Is greater than to | |
NULL_ARGUMENT | nodeId, pathGenusType, from or to is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPathsForEndingNode | ||
Description |
Gets a In effective mode, paths are returned that are currently effective. In any effective mode, effective paths and those currently expired are returned. | ||
Parameters | osid.id.Id | nodeId | a node Id |
Return | osid.topology.path.PathList | the returned Path list | |
Errors | NULL_ARGUMENT | nodeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPathsForEndingNodeOnDate | ||
Description |
Gets a In effective mode, paths are returned that are currently effective. In any effective mode, effective paths and those currently expired are returned. | ||
Parameters | osid.id.Id | nodeId | a node Id |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.topology.path.PathList | the returned Path list | |
Errors | INVALID_ARGUMENT | from Is greater than to | |
NULL_ARGUMENT | nodeId, from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPathsByGenusTypeForEndingNode | ||
Description |
Gets a In effective mode, paths are returned that are currently effective. In any effective mode, effective paths and those currently expired are returned. | ||
Parameters | osid.id.Id | nodeId | a node Id |
osid.type.Type | pathGenusType | a path genus type | |
Return | osid.topology.path.PathList | the returned Path list | |
Errors | NULL_ARGUMENT | nodeId or pathGenusType null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPathsByGenusTypeForEndingNodeOnDate | ||
Description |
Gets a In effective mode, paths are returned that are currently effective. In any effective mode, effective paths and those currently expired are returned. | ||
Parameters | osid.id.Id | nodeId | a node Id |
osid.type.Type | pathGenusType | a path genus type | |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.topology.path.PathList | the returned Path list | |
Errors | INVALID_ARGUMENT | from Is greater than to | |
NULL_ARGUMENT | nodeId, pathGenusType, from or to is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPathsForNodes | ||
Description |
Gets a In effective mode, paths are returned that are currently effective. In any effective mode, effective paths and those currently expired are returned. | ||
Parameters | osid.id.Id | startingNodeId | starting node Id |
osid.id.Id | endingNodeId | ending node Id | |
Return | osid.topology.path.PathList | the returned Path list | |
Errors | NULL_ARGUMENT | startingNodeId or endingNodeId is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPathsForNodesOnDate | ||
Description |
Gets a In effective mode, paths are returned that are currently effective. In any effective mode, effective paths and those currently expired are returned. | ||
Parameters | osid.id.Id | startingNodeId | starting node Id |
osid.id.Id | endingNodeId | ending node Id | |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.topology.path.PathList | the returned Path list | |
Errors | INVALID_ARGUMENT | from Is greater than to | |
NULL_ARGUMENT | startingNodeId, endingNodeId, from or to is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPathsByGenusTypeForNodes | ||
Description |
Gets a In effective mode, paths are returned that are currently effective. In any effective mode, effective paths and those currently expired are returned. | ||
Parameters | osid.id.Id | startingNodeId | starting node Id |
osid.id.Id | endingNodeId | ending node Id | |
osid.type.Type | pathGenusType | a path genus type | |
Return | osid.topology.path.PathList | the returned Path list | |
Errors | NULL_ARGUMENT | startingNodeId, endingNodeId or pathGenusType
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPathsByGenusTypeForNodesOnDate | ||
Description |
Gets a In effective mode, paths are returned that are currently effective. In any effective mode, effective paths and those currently expired are returned. | ||
Parameters | osid.id.Id | startingNodeId | starting node Id |
osid.id.Id | endingNodeId | ending node Id | |
osid.type.Type | pathGenusType | a path genus type | |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
Return | osid.topology.path.PathList | the returned Path list | |
Errors | INVALID_ARGUMENT | from Is greater than to | |
NULL_ARGUMENT | startingNodeId, endingNodeId, pathGenusType, from or
to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPathsAlongNodes | ||
Description |
Gets a In effective mode, paths are returned that are currently effective. In any effective mode, effective paths and those currently expired are returned. | ||
Parameters | osid.id.IdList | nodeIds | the list of Ids to retrieve |
Return | osid.topology.path.PathList | the returned Path list | |
Errors | NULL_ARGUMENT | nodeIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPathsAlongNodesOnDate | ||
Description |
Gets a In plenary mode, the returned list contains all of the
paths through the nodes, or an error results if a path
connected to the node is not found or inaccessible.
Otherwise, inaccessible In effective mode, paths are returned that are currently effective. In any effective mode, effective paths and those currently expired are returned. | ||
Parameters | osid.id.IdList | nodeIds | the list of Ids to retrieve |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.topology.path.PathList | the returned Path list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | nodeIds, from , or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPaths | ||
Description |
Gets all In plenary mode, the returned list contains all known paths or an error results. Otherwise, the returned list may contain only those paths that are accessible through this session. In effective mode, paths are returned that are currently effective. In any effective mode, effective paths and those currently expired are returned. | ||
Return | osid.topology.path.PathList | a list of Paths | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |