Interface | osid.mapping.path.rules.SpeedZoneEnablerLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
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 | ||
Method | getMapId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Map Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getMap | ||
Description |
Gets the | ||
Return | osid.mapping.Map | the map | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupSpeedZoneEnablers | ||
Description |
Tests if this user can perform | ||
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 | ||
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 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 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 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 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 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 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 |
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 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 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 | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |