OSID - osid.mapping.LocationSmartMapSession Service Interface Definition

Interface	osid.mapping.LocationSmartMapSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `LocationQuery` can be retrieved from this session and mapped to this `Map` to create a virtual collection of `Locations.` The locations may be sequenced using the `LocationSearchOrder` from this session. This `Map` has a default query that matches any location and a default search order that specifies no sequencing. The queries may be examined using a `LocationQueryInspector.` The query may be modified by converting the inspector back to a `LocationQuery.`
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	getLocationQuery
Description	Gets a location query.
Return	`osid.mapping.LocationQuery`		the location query
Compliance	`mandatory`		This method must be implemented.
Method	getLocationSearchOrder
Description	Gets a location search order.
Return	`osid.mapping.LocationSearchOrder`		the location search order
Compliance	`mandatory`		This method must be implemented.
Method	applyLocationQuery
Description	Applies a location query to this map.
Parameters	`osid.mapping.LocationQuery`	`locationQuery`	the location query
Errors	NULL_ARGUMENT		`locationQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`locationQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspecLocationQuery
Description	Gets a location query inspector for this map.
Return	`osid.mapping.LocationQueryInspector`		the location query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyLocationSequencing
Description	Applies a location search order to this map.
Parameters	`osid.mapping.LocationSearchOrder`	`locationSearchOrder`	the location search order
Errors	NULL_ARGUMENT		`locationSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`locationSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getLocationQueryFromInspector
Description	Gets a location query from an inspector.
Parameters	`osid.mapping.LocationQueryInspector`	`locationQueryInspector`	a location query inspector
Return	`osid.mapping.LocationQuery`		the location query
Errors	NULL_ARGUMENT		`locationQueryInspector` is `null`
Errors	UNSUPPORTED		`locationQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.