Interface | osid.mapping.path.IntersectionLookupSession | ||
---|---|---|---|
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 | getMapId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Map Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getMap | ||
Description |
Gets the | ||
Return | osid.mapping.Map | the map | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupIntersections | ||
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 | useComparativeIntersectionView | ||
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 | usePlenaryIntersectionView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedMapView | ||
Description |
Federates the view for methods in this session. A federated view will include intersections in maps which are children of this map in the map hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedMapView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this map only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getIntersection | ||
Description |
Gets the | ||
Parameters | osid.id.Id | intersectionId | Id of the Intersection |
Return | osid.mapping.path.Intersection | the intersection | |
Errors | NOT_FOUND | intersectionId not found | |
NULL_ARGUMENT | intersectionId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getIntersectionsByIds | ||
Description |
Gets an | ||
Parameters | osid.id.IdList | intersectionIds | the list of Ids to retrieve |
Return | osid.mapping.path.IntersectionList | the returned Intersection list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | intersectionIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIntersectionsByGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | pathGenusType | a path genus type |
Return | osid.mapping.path.IntersectionList | 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 | getIntersectionsByParentGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | intersectionGenusType | an intersection genus type |
Return | osid.mapping.path.IntersectionList | the returned Intersection list | |
Errors | NULL_ARGUMENT | intersectionGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIntersectionsByRecordType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | intersectionRecordType | an intersection record type |
Return | osid.mapping.path.IntersectionList | the returned Intersection list | |
Errors | NULL_ARGUMENT | intersectionRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIntersectionsForPath | ||
Description |
Gets an | ||
Parameters | osid.id.Id | pathId | a path Id |
Return | osid.mapping.path.IntersectionList | the returned Intersection list | |
Errors | NULL_ARGUMENT | pathId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIntersectionsForPathAtCoordinate | ||
Description |
Gets an | ||
Parameters | osid.id.Id | pathId | a path Id |
osid.mapping.Coordinate | coordinate | a coordinate | |
osid.mapping.Distance | distance | a distance | |
Return | osid.mapping.path.IntersectionList | the returned Intersection list | |
Errors | NULL_ARGUMENT | pathId, coordinate or distance is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIntersectionsForPaths | ||
Description |
Gets the | ||
Parameters | osid.id.Id | pathId | a path Id |
osid.id.Id | crossingPathId | another path Id | |
Return | osid.mapping.path.IntersectionList | the returned Intersection list | |
Errors | NULL_ARGUMENT | pathId or crossingPathId is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIntersections | ||
Description |
Gets all | ||
Return | osid.mapping.path.IntersectionList | the returned Intersection list | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |