OSID - osid.mapping.path.IntersectionLookupSession Service Interface Definition

Interface	osid.mapping.path.IntersectionLookupSession
Implements	`osid.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.
Method	getMapId
Description	Gets the `Map` `Id` associated with this session.
Return	`osid.id.Id`		the `Map Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getMap
Description	Gets the `Map` associated with this session.
Return	`osid.mapping.Map`		the map
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupIntersections
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.
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 `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.
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 `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.
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 `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.
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 `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.
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 `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.
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 `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.
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 `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.
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 `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.
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 `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.
Parameters	`osid.id.Id`	`pathId`	a path `Id`
Parameters	`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 `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.
Return	`osid.mapping.path.IntersectionList`		the returned `Intersection` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.