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

Interface	osid.mapping.path.PathLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Path` objects. The `Path` represents a fixed connection between two `Locations.` 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 path methods in this session operate, retrieve and pertain to paths defined explicitly in the current map. Using an isolated view is useful for managing `Paths` with the `PathAdminSession.` federated map view: All path methods in this session operate, retrieve and pertain to all paths 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	canLookupPaths
Description	Tests if this user can perform `Path` 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	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 `Path` 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 paths 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	getPath
Description	Gets the `Path` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Path` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Path` and retained for compatibility.
Parameters	`osid.id.Id`	`pathId`	`Id` of the `Path`
Return	`osid.mapping.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 `PathList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the paths 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 `Paths` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`pathIds`	the list of `Ids` to retrieve
Return	`osid.mapping.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 `PathList` corresponding to the given path genus `Type` which does not include paths of genus types derived from the specified `Type.` 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.
Parameters	`osid.type.Type`	`pathGenusType`	a path genus type
Return	`osid.mapping.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 `PathList` corresponding to the given path genus `Type` and include any additional paths with genus types derived from the specified `Type.` 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.
Parameters	`osid.type.Type`	`pathGenusType`	a path genus type
Return	`osid.mapping.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 `PathList` containing the given path record `Type.` 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.
Parameters	`osid.type.Type`	`pathRecordType`	a path record type
Return	`osid.mapping.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	getPathsAlongLocations
Description	Gets a `PathList` connected to all the given `Locations.` In plenary mode, the returned list contains all of the paths along the locations, 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.IdList`	`locationIds`	the list of `Ids` to retrieve
Return	`osid.mapping.path.PathList`		the returned `Path` list
Errors	NULL_ARGUMENT		`locationIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPaths
Description	Gets all `Paths.` 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.
Return	`osid.mapping.path.PathList`		a list of `Paths`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.