public interface SpeedZoneEnablerLookupSession extends OsidSession
This session provides methods for retrieving SpeedZoneEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
SpeedZoneEnablers
with the
SpeedZoneEnablerAdminSession.
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.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupSpeedZoneEnablers()
Tests if this user can perform
SpeedZoneEnablers
lookups. |
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
SpeedZoneEnabler |
getSpeedZoneEnabler(Id speedZoneEnablerId)
Gets the
SpeedZoneEnabler specified by its Id. |
SpeedZoneEnablerList |
getSpeedZoneEnablers()
Gets all
SpeedZoneEnablers. |
SpeedZoneEnablerList |
getSpeedZoneEnablersByGenusType(Type speedZoneEnablerGenusType)
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. |
SpeedZoneEnablerList |
getSpeedZoneEnablersByIds(IdList speedZoneEnablerIds)
Gets a
SpeedZoneEnablerList corresponding to the given
IdList. |
SpeedZoneEnablerList |
getSpeedZoneEnablersByParentGenusType(Type speedZoneEnablerGenusType)
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. |
SpeedZoneEnablerList |
getSpeedZoneEnablersByRecordType(Type speedZoneEnablerRecordType)
Gets a
SpeedZoneEnablerList containing the given speed
zone enabler record Type. |
SpeedZoneEnablerList |
getSpeedZoneEnablersOnDate(DateTime from,
DateTime to)
Gets a
SpeedZoneEnablerList that are effective for the
entire given date range inclusive but not confined to the date range
for any agent. |
SpeedZoneEnablerList |
getSpeedZoneEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
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. |
void |
useActiveSpeedZoneEnablerView()
Only active speed zone enablers are returned by methods in this
session.
|
void |
useAnyStatusSpeedZoneEnablerView()
All active and inactive speed zone enablers are returned by methods in
this session.
|
void |
useComparativeSpeedZoneEnablerView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedMapView()
Federates the view for methods in this session.
|
void |
useIsolatedMapView()
Isolates the view for methods in this session.
|
void |
usePlenarySpeedZoneEnablerView()
A complete view of the
SpeedZoneEnabler returns is
desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getMapId()
Map
Id
associated with this
session. Map Id
associated with this sessionmandatory
- This method must be implemented. Map getMap() throws OperationFailedException, PermissionDeniedException
Map
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupSpeedZoneEnablers()
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. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeSpeedZoneEnablerView()
mandatory
- This method is must be implemented. void usePlenarySpeedZoneEnablerView()
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.mandatory
- This method is must be implemented. void useFederatedMapView()
mandatory
- This method is must be implemented. void useIsolatedMapView()
mandatory
- This method is must be implemented. void useActiveSpeedZoneEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusSpeedZoneEnablerView()
mandatory
- This method is must be implemented. SpeedZoneEnabler getSpeedZoneEnabler(Id speedZoneEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
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.speedZoneEnablerId
- Id
of the
SpeedZoneEnabler
NotFoundException
- speedZoneEnablerId
not foundNullArgumentException
- speedZoneEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. SpeedZoneEnablerList getSpeedZoneEnablersByIds(IdList speedZoneEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
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.speedZoneEnablerIds
- the list of Ids
to retrieve SpeedZoneEnabler
listNotFoundException
- a Id was
not foundNullArgumentException
- speedZoneEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SpeedZoneEnablerList getSpeedZoneEnablersByGenusType(Type speedZoneEnablerGenusType) throws OperationFailedException, PermissionDeniedException
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.speedZoneEnablerGenusType
- a speed zone enabler genus type SpeedZoneEnabler
listNullArgumentException
-
speedZoneEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SpeedZoneEnablerList getSpeedZoneEnablersByParentGenusType(Type speedZoneEnablerGenusType) throws OperationFailedException, PermissionDeniedException
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.speedZoneEnablerGenusType
- a speed zone enabler genus type SpeedZoneEnabler
listNullArgumentException
-
speedZoneEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SpeedZoneEnablerList getSpeedZoneEnablersByRecordType(Type speedZoneEnablerRecordType) throws OperationFailedException, PermissionDeniedException
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.speedZoneEnablerRecordType
- a speed zone enabler record type SpeedZoneEnabler
listNullArgumentException
-
speedZoneEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SpeedZoneEnablerList getSpeedZoneEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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.from
- a start dateto
- an end date SpeedZoneEnabler
listInvalidArgumentException
- from
is
greater tha to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SpeedZoneEnablerList getSpeedZoneEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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.agentId
- an agent Id
from
- a start dateto
- an end date SpeedZoneEnabler
listInvalidArgumentException
- from
is
greater tha to
NullArgumentException
- agentId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SpeedZoneEnablerList getSpeedZoneEnablers() throws OperationFailedException, PermissionDeniedException
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. SpeedZoneEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.