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

Interface	osid.mapping.path.PathQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.mapping.path.PathSearchSession`
Used By	`osid.mapping.path.MappingPathManager`
Used By	`osid.mapping.path.MappingPathProxyManager`
Description	This session provides methods for searching among `Path` objects. The search query is constructed using the `PathQuery`. This session defines views that offer differing behaviors for searching. federated map view: searches include paths in maps of which this map is an ancestor in the map hierarchy isolated map view: searches are restricted to paths in this map Paths may have a query record indicated by their respective record types. The query record is accessed via the `PathQuery`.
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	canSearchPaths
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 not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method 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 searches to this map only.
Compliance	`mandatory`		This method is must be implemented.
Method	getPathQuery
Description	Gets a path query.
Return	`osid.mapping.path.PathQuery`		the path query
Compliance	`mandatory`		This method must be implemented.
Method	getPathsByQuery
Description	Gets a list of `Paths` matching the given path query.
Parameters	`osid.mapping.path.PathQuery`	`pathQuery`	the path query
Return	`osid.mapping.path.PathList`		the returned `PathList`
Errors	NULL_ARGUMENT		`pathQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`pathQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.