OSID Logo
OSID Specifications
mapping path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.IntersectionLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving Intersections. The Intersection represents a crossing of two Paths.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated map view: All intersection methods in this session operate, retrieve and pertain to intersections defined explicitly in the current map. Using an isolated view is useful for managing Intersections with the IntersectionAdminSession.
  • federated map view: All intersections methods in this session operate, retrieve and pertain to all intersections defined in this map and any other paths implicitly available in this map through map inheritence.

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 useFederatedMapView() and useIsolatedMapView() behave as a radio group and one should be selected before invoking any lookup methods.

MethodgetMapId
Description

Gets the Map Id associated with this session.

Returnosid.id.Idthe Map Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetMap
Description

Gets the Map associated with this session.

Returnosid.mapping.Mapthe map
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupIntersections
Description

Tests if this user can perform Intersection lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeIntersectionView
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.
MethodusePlenaryIntersectionView
Description

A complete view of the Intersection 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.
MethoduseFederatedMapView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedMapView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this map only.

CompliancemandatoryThis method is must be implemented.
MethodgetIntersection
Description

Gets the Intersection specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Intersection may have a different Id than requested.

Parametersosid.id.IdintersectionId Id of the Intersection
Returnosid.mapping.path.Intersectionthe intersection
ErrorsNOT_FOUND intersectionId not found
NULL_ARGUMENT intersectionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetIntersectionsByIds
Description

Gets an IntersectionList corresponding to the given IdList. In plenary mode, the returned list contains all of the intersections specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Intersections may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListintersectionIdsthe list of Ids to retrieve
Returnosid.mapping.path.IntersectionListthe returned Intersection list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT intersectionIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIntersectionsByGenusType
Description

Gets an IntersectionList corresponding to the given intersection genus Type which does not include intersections of genus types derived from the specified Type. In plenary mode, the returned list contains all known intersections or an error results. Otherwise, the returned list may contain only those intersections that are accessible through this session.

Parametersosid.type.TypepathGenusTypea path genus type
Returnosid.mapping.path.IntersectionListthe returned Path list
ErrorsNULL_ARGUMENT pathGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIntersectionsByParentGenusType
Description

Gets an IntersectionList corresponding to the given intersection genus Type and include any additional intersections with genus types derived from the specified Type. In plenary mode, the returned list contains all known intersections or an error results. Otherwise, the returned list may contain only those intersections that are accessible through this session.

Parametersosid.type.TypeintersectionGenusTypean intersection genus type
Returnosid.mapping.path.IntersectionListthe returned Intersection list
ErrorsNULL_ARGUMENT intersectionGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIntersectionsByRecordType
Description

Gets an IntersectionList containing the given intersection record Type. In plenary mode, the returned list contains all known intersections or an error results. Otherwise, the returned list may contain only those intersections that are accessible through this session.

Parametersosid.type.TypeintersectionRecordTypean intersection record type
Returnosid.mapping.path.IntersectionListthe returned Intersection list
ErrorsNULL_ARGUMENT intersectionRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIntersectionsForPath
Description

Gets an IntersectionList connected to the given Path. In plenary mode, the returned list contains all of the intersections, or an error results if an intersection along the path is not found or inaccessible. Otherwise, inaccessible Intersections may be omitted from the list.

Parametersosid.id.IdpathIda path Id
Returnosid.mapping.path.IntersectionListthe returned Intersection list
ErrorsNULL_ARGUMENT pathId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIntersectionsForPathAtCoordinate
Description

Gets an IntersectionList connected to the given Path within a distance of a given coordinate. In plenary mode, the returned list contains all of the paths, or an error results if a path connected to the location is not found or inaccessible. Otherwise, inaccessible Paths may be omitted from the list.

Parametersosid.id.IdpathIda path Id
osid.mapping.Coordinatecoordinatea coordinate
osid.mapping.Distancedistancea distance
Returnosid.mapping.path.IntersectionListthe returned Intersection list
ErrorsNULL_ARGUMENT pathId, coordinate or distance is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIntersectionsForPaths
Description

Gets the Intersections of both given paths. In plenary mode, the returned list contains all of the intersections, or an error results if an intersection along the path is not found or inaccessible. Otherwise, inaccessible Intersections may be omitted from the list.

Parametersosid.id.IdpathIda path Id
osid.id.IdcrossingPathIdanother path Id
Returnosid.mapping.path.IntersectionListthe returned Intersection list
ErrorsNULL_ARGUMENT pathId or crossingPathId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIntersections
Description

Gets all Intersection. In plenary mode, the returned list contains all of the intersections. or an error results if an intersection is not found or inaccessible. Otherwise, inaccessible Intersections may be omitted from the list.

Returnosid.mapping.path.IntersectionListthe returned Intersection list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.