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

Interface	osid.mapping.path.SpeedZoneMapSession
Implements	`osid.OsidSession`
Used By	`osid.mapping.path.MappingPathManager`
Used By	`osid.mapping.path.MappingPathProxyManager`
Description	This session provides methods to retrieve `SpeedZone` to `Map` speed zones. A `SpeedZone` may appear in multiple `Map` objects. Each map may have its own authorizations governing who is allowed to look at it. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition
Method	canLookupSpeedZoneMapSpeedZones
Description	Tests if this user can perform lookups of speed zone/map speed zones. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up speed zones is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeSpeedZoneMapView
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	usePlenarySpeedZoneMapView
Description	A complete view of the `SpeedZone` and `Map` 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	getSpeedZoneIdsByMap
Description	Gets the list of `SpeedZone Ids` associated with a `Map`.
Parameters	`osid.id.Id`	`mapId`	`Id` of the `Map`
Return	`osid.id.IdList`		list of related speed zone `Ids`
Errors	NOT_FOUND		`mapId` is not found
	NULL_ARGUMENT		`mapId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedZonesByMap
Description	Gets the list of `SpeedZones` associated with a `Map`.
Parameters	`osid.id.Id`	`mapId`	`Id` of the `Map`
Return	`osid.mapping.path.SpeedZoneList`		list of related speed zones
Errors	NOT_FOUND		`mapId` is not found
	NULL_ARGUMENT		`mapId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedZoneIdsByMaps
Description	Gets the list of `SpeedZone Ids` corresponding to a list of `Maps`.
Parameters	`osid.id.IdList`	`mapIds`	list of map `Ids`
Return	`osid.id.IdList`		list of speed zone `Ids`
Errors	NULL_ARGUMENT		`mapIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedZonesByMaps
Description	Gets the list of `SpeedZones` corresponding to a list of `Maps`.
Parameters	`osid.id.IdList`	`mapIds`	list of map `Ids`
Return	`osid.mapping.path.SpeedZoneList`		list of speed zones
Errors	NULL_ARGUMENT		`mapIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMapIdsBySpeedZone
Description	Gets the `Map` `Ids` mapped to a `SpeedZone`.
Parameters	`osid.id.Id`	`speedZoneId`	`Id` of a `SpeedZone`
Return	`osid.id.IdList`		list of maps
Errors	NOT_FOUND		`speedZoneId` is not found
	NULL_ARGUMENT		`speedZoneId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMapsBySpeedZone
Description	Gets the `Maps` mapped to a `SpeedZone`.
Parameters	`osid.id.Id`	`speedZoneId`	`Id` of a `SpeedZone`
Return	`osid.mapping.MapList`		list of maps
Errors	NOT_FOUND		`speedZoneId` is not found
	NULL_ARGUMENT		`speedZoneId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.