OSID Logo
OSID Specifications
mapping path rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.rules.SpeedZoneEnablerLookupSession
Implementsosid.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.

MethodgetMapId
Description

Gets the Map Id associated with this session.

Returnosid.id.Idthe Map Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetMap
Description

Gets the Map associated with this session.

Returnosid.mapping.Mapthe map
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupSpeedZoneEnablers
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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeSpeedZoneEnablerView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenarySpeedZoneEnablerView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedMapView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedMapView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this map only.

CompliancemandatoryThis method is must be implemented.
MethoduseActiveSpeedZoneEnablerView
Description

Only active speed zone enablers are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusSpeedZoneEnablerView
Description

All active and inactive speed zone enablers are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetSpeedZoneEnabler
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.

Parametersosid.id.IdspeedZoneEnablerId Id of the SpeedZoneEnabler
Returnosid.mapping.path.rules.SpeedZoneEnablerthe speed zone enabler
ErrorsNOT_FOUND speedZoneEnablerId not found
NULL_ARGUMENT speedZoneEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetSpeedZoneEnablersByIds
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.

Parametersosid.id.IdListspeedZoneEnablerIdsthe list of Ids to retrieve
Returnosid.mapping.path.rules.SpeedZoneEnablerListthe returned SpeedZoneEnabler list
ErrorsNOT_FOUNDa Id was not found
NULL_ARGUMENT speedZoneEnablerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZoneEnablersByGenusType
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.

Parametersosid.type.TypespeedZoneEnablerGenusTypea speed zone enabler genus type
Returnosid.mapping.path.rules.SpeedZoneEnablerListthe returned SpeedZoneEnabler list
ErrorsNULL_ARGUMENT speedZoneEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZoneEnablersByParentGenusType
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.

Parametersosid.type.TypespeedZoneEnablerGenusTypea speed zone enabler genus type
Returnosid.mapping.path.rules.SpeedZoneEnablerListthe returned SpeedZoneEnabler list
ErrorsNULL_ARGUMENT speedZoneEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZoneEnablersByRecordType
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.

Parametersosid.type.TypespeedZoneEnablerRecordTypea speed zone enabler record type
Returnosid.mapping.path.rules.SpeedZoneEnablerListthe returned SpeedZoneEnabler list
ErrorsNULL_ARGUMENT speedZoneEnablerRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZoneEnablersOnDate
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.

Parametersosid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.mapping.path.rules.SpeedZoneEnablerListthe returned SpeedZoneEnabler list
ErrorsINVALID_ARGUMENT from is greater tha to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZoneEnablersOnDateWithAgent
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.

Parametersosid.id.IdagentIdan agent Id
osid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.mapping.path.rules.SpeedZoneEnablerListthe returned SpeedZoneEnabler list
ErrorsINVALID_ARGUMENT from is greater tha to
NULL_ARGUMENT agentId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZoneEnablers
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.

Returnosid.mapping.path.rules.SpeedZoneEnablerListthe returned SpeedZoneEnabler list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.