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

Interface	osid.mapping.path.IntersectionSmartMapSession
Implements	`osid.OsidSession`
Used By	`osid.mapping.path.MappingPathManager`
Used By	`osid.mapping.path.MappingPathProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. An `IntersectionQuery` can be retrieved from this session and mapped to this `Map` to create a virtual collection of `Intersections`. The intersections may be sequenced using the `IntersectionSearchOrder` from this session. This `Map` has a default query that matches any intersection and a default search order that specifies no sequencing. The queries may be examined using an `IntersectionQueryInspector`. The query may be modified by converting the inspector back to an `IntersectionQuery`.
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	canManageSmartMaps
Description	Tests if this user can manage smart maps. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
Return	`boolean`		`false` if smart map management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getIntersectionQuery
Description	Gets an intersection query.
Return	`osid.mapping.path.IntersectionQuery`		the intersection query
Compliance	`mandatory`		This method must be implemented.
Method	getIntersectionSearchOrder
Description	Gets an intersection search order.
Return	`osid.mapping.path.IntersectionSearchOrder`		the intersection search order
Compliance	`mandatory`		This method must be implemented.
Method	applyIntersectionQuery
Description	Applies an intersection query to this map.
Parameters	`osid.mapping.path.IntersectionQuery`	`intersectionQuery`	the intersection query
Errors	NULL_ARGUMENT		`intersectionQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`intersectionQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectIntersectionQuery
Description	Gets an intersection query inspector for this map.
Return	`osid.mapping.path.IntersectionQueryInspector`		the intersection query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyIntersectionSequencing
Description	Applies an intersection search order to this map.
Parameters	`osid.mapping.path.IntersectionSearchOrder`	`intersectionSearchOrder`	the intersection search order
Errors	NULL_ARGUMENT		`intersectionSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`intersectionsearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getIntersectionQueryFromInspector
Description	Gets an intersection query from an inspector.
Parameters	`osid.mapping.path.IntersectionQueryInspector`	`intersectionQueryInspector`	an intersection query inspector
Return	`osid.mapping.path.IntersectionQuery`		the intersection query
Errors	NULL_ARGUMENT		`intersectionQueryInspector` is `null`
Errors	UNSUPPORTED		`intersectionQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.