OSID - osid.mapping.path.rules.SpeedZoneEnablerLookupSession Service Interface Definition

Interface	osid.mapping.path.rules.SpeedZoneEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `SpeedZoneEnablers.` This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated map view: All speed zone enabler methods in this session operate, retrieve and pertain to speed zone enablers defined explicitly in the current map. Using an isolated view is useful for managing `SpeedZoneEnablers` with the `SpeedZoneEnablerAdminSession.` federated map view: All speed zone enabler methods in this session operate, retrieve and pertain to all speed zone enablers defined in this map and any other speed zone enablers implicitly available in this map through map inheritence. active speed zone enabler view: All speed zone enabler lookup methods return active speed zone enablers. any active speed zone enabler view: Speed zone enablers of any active or inactive status are returned from methods. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods `useFederatedMapView()` and `useIsolatedMapView()` behave as a radio group and one should be selected before invoking the methods in this session.
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	canLookupSpeedZoneEnablers
Description	Tests if this user can perform `SpeedZoneEnablers` 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 opt not to offer lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeSpeedZoneEnablerView
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	usePlenarySpeedZoneEnablerView
Description	A complete view of the `SpeedZoneEnabler` 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	useFederatedMapView
Description	Federates the view for methods in this session. A federated view will include speed zone enablers 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 lookups to this map only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveSpeedZoneEnablerView
Description	Only active speed zone enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusSpeedZoneEnablerView
Description	All active and inactive speed zone enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getSpeedZoneEnabler
Description	Gets the `SpeedZoneEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `SpeedZoneEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `SpeedZoneEnabler` and retained for compatibility. In active mode, speed zone enablers are returned that are currently active. In any status mode, active and inactive speed zone enablers are returned.
Parameters	`osid.id.Id`	`speedZoneEnablerId`	`Id` of the `SpeedZoneEnabler`
Return	`osid.mapping.path.rules.SpeedZoneEnabler`		the speed zone enabler
Errors	NOT_FOUND		`speedZoneEnablerId` not found
	NULL_ARGUMENT		`speedZoneEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getSpeedZoneEnablersByIds
Description	Gets a `SpeedZoneEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the speed zone enablers specified in the `Id` list, in the order of the list, including duplicates, or an error results if a `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `SpeedZoneEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, speed zone enablers are returned that are currently active. In any status mode, active and inactive speed zone enablers are returned.
Parameters	`osid.id.IdList`	`speedZoneEnablerIds`	the list of `Ids` to retrieve
Return	`osid.mapping.path.rules.SpeedZoneEnablerList`		the returned `SpeedZoneEnabler` list
Errors	NOT_FOUND		a `Id was` not found
	NULL_ARGUMENT		`speedZoneEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedZoneEnablersByGenusType
Description	Gets a `SpeedZoneEnablerList` corresponding to the given speed zone enabler genus `Type` which does not include speed zone enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known speed zone enablers or an error results. Otherwise, the returned list may contain only those speed zone enablers that are accessible through this session. In active mode, speed zone enablers are returned that are currently active. In any status mode, active and inactive speed zone enablers are returned.
Parameters	`osid.type.Type`	`speedZoneEnablerGenusType`	a speed zone enabler genus type
Return	`osid.mapping.path.rules.SpeedZoneEnablerList`		the returned `SpeedZoneEnabler` list
Errors	NULL_ARGUMENT		`speedZoneEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedZoneEnablersByParentGenusType
Description	Gets a `SpeedZoneEnablerList` corresponding to the given speed zone enabler genus `Type` and include any additional speed zone enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known speed zone enablers or an error results. Otherwise, the returned list may contain only those speed zone enablers that are accessible through this session. In active mode, speed zone enablers are returned that are currently active. In any status mode, active and inactive speed zone enablers are returned.
Parameters	`osid.type.Type`	`speedZoneEnablerGenusType`	a speed zone enabler genus type
Return	`osid.mapping.path.rules.SpeedZoneEnablerList`		the returned `SpeedZoneEnabler` list
Errors	NULL_ARGUMENT		`speedZoneEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedZoneEnablersByRecordType
Description	Gets a `SpeedZoneEnablerList` containing the given speed zone enabler record `Type.` In plenary mode, the returned list contains all known speed zone enablers or an error results. Otherwise, the returned list may contain only those speed zone enablers that are accessible through this session. In active mode, speed zone enablers are returned that are currently active. In any status mode, active and inactive speed zone enablers are returned.
Parameters	`osid.type.Type`	`speedZoneEnablerRecordType`	a speed zone enabler record type
Return	`osid.mapping.path.rules.SpeedZoneEnablerList`		the returned `SpeedZoneEnabler` list
Errors	NULL_ARGUMENT		`speedZoneEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedZoneEnablersOnDate
Description	Gets a `SpeedZoneEnablerList` that are effective for the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known speed zone enablers or an error results. Otherwise, the returned list may contain only those speed zone enablers that are accessible through this session. In active mode, speed zone enablers are returned that are currently active. In any status mode, active and inactive speed zone enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.mapping.path.rules.SpeedZoneEnablerList`		the returned `SpeedZoneEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater tha `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedZoneEnablersOnDateWithAgent
Description	Gets a `SpeedZoneEnablerList` that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known speed zone enablers or an error results. Otherwise, the returned list may contain only those speed zone enablers that are accessible through this session. In active mode, speed zone enablers are returned that are currently active. In any status mode, active and inactive speed zone enablers are returned.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
	`osid.calendaring.DateTime`	`from`	a start date
	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.mapping.path.rules.SpeedZoneEnablerList`		the returned `SpeedZoneEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater tha `to`
	NULL_ARGUMENT		`agentId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedZoneEnablers
Description	Gets all `SpeedZoneEnablers.` In plenary mode, the returned list contains all known speed zone enablers or an error results. Otherwise, the returned list may contain only those speed zone enablers that are accessible through this session. In active mode, speed zone enablers are returned that are currently active. In any status mode, active and inactive speed zone enablers are returned.
Return	`osid.mapping.path.rules.SpeedZoneEnablerList`		the returned `SpeedZoneEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.