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

Interface	osid.mapping.path.PathSmartMapSession
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. A `PathQuery` can be retrieved from this session and mapped to this `Map` to create a virtual collection of `Paths`. The paths may be sequenced using the `PathSearchOrder` from this session. This `Map` has a default query that matches any path and a default search order that specifies no sequencing. The queries may be examined using a `PathQueryInspector`. The query may be modified by converting the inspector back to a `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	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	getPathQuery
Description	Gets a path query.
Return	`osid.mapping.path.PathQuery`		the path query
Compliance	`mandatory`		This method must be implemented.
Method	getPathSearchOrder
Description	Gets a path search order.
Return	`osid.mapping.path.PathSearchOrder`		the path search order
Compliance	`mandatory`		This method must be implemented.
Method	applyPathQuery
Description	Applies a path query to this map.
Parameters	`osid.mapping.path.PathQuery`	`pathQuery`	the path query
Errors	NULL_ARGUMENT		`pathQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`pathQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectPathQuery
Description	Gets a path query inspector for this map.
Return	`osid.mapping.path.PathQueryInspector`		the path query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyPathSequencing
Description	Applies a path search order to this map.
Parameters	`osid.mapping.path.PathSearchOrder`	`pathSearchOrder`	the path search order
Errors	NULL_ARGUMENT		`pathSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`pathSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPathQueryFromInspector
Description	Gets a path query from an inspector.
Parameters	`osid.mapping.path.PathQueryInspector`	`pathQueryInspector`	a path query inspector
Return	`osid.mapping.path.PathQuery`		the path query
Errors	NULL_ARGUMENT		`pathQueryInspector` is `null`
Errors	UNSUPPORTED		`pathQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.