public interface SignalLookupSession extends OsidSession
This session defines methods for retrieving signals.
This lookup session defines several views:
Signals
with the SignalAdminSession.
The methods useFederatedMapView()
and
useIsolatedMapView()
behave as a radio group and one should be
selected before invoking any lookup methods.
Signals may have an additional records indicated by their respective
record types. The record may not be accessed through a cast of the
Signals.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupSignals()
Tests if this user can perform
Signal lookups. |
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
Signal |
getSignal(Id signalId)
Gets the
Signal specified by its Id. |
SignalList |
getSignals()
Gets all
Signals. |
SignalList |
getSignalsByGenusType(Type signalGenusType)
Gets a
SignalList corresponding to the given signal
genus Type which does not include signals of types
derived from the specified Type. |
SignalList |
getSignalsByIds(IdList signalIds)
Gets a
SignalList corresponding to the given
IdList. |
SignalList |
getSignalsByParentGenusType(Type signalGenusType)
Gets a
SignalList corresponding to the given signal
genus Type and include any additional signals with
genus types derived from the specified Type. |
SignalList |
getSignalsByRecordType(Type signalRecordType)
Gets a
SignalList containing the given signal record
Type. |
SignalList |
getSignalsForPath(Id pathId)
Gets a
SignalList containing the given path. |
SignalList |
getSignalsForPathAtCoordinate(Id pathId,
Coordinate coordinate,
Distance distance)
Gets a
SignalList containing the given path between the
given coordinates inclusive. |
void |
useActiveSignalView()
Only active signals are returned by methods in this session.
|
void |
useAnyStatusSignalView()
All active and inactive signals are returned by methods in this
session.
|
void |
useComparativeSignalView()
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 |
usePlenarySignalView()
A complete view of the
Signal 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 canLookupSignals()
Signal
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 not offer lookup operations to unauthorized
users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeSignalView()
mandatory
- This method is must be implemented. void usePlenarySignalView()
Signal
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 useActiveSignalView()
mandatory
- This method is must be implemented. void useAnyStatusSignalView()
mandatory
- This method is must be implemented. Signal getSignal(Id signalId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Signal
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Signal
may have a different Id
than requested,
such as the case where a duplicate Id
was assigned to a
Signal
and retained for compatibility.
In active mode, signals are returned that are currently active. In any
status mode, active and inactive signals are returned.signalId
- the Id
of the Signal
to
retrieve Signal
NotFoundException
- no Signal
found with
the given Id
NullArgumentException
- signalId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SignalList getSignalsByIds(IdList signalIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
SignalList
corresponding to the given
IdList.
I
n plenary mode, the returned list contains all of the signals
specified in the Id
list, in the order of the list,
including duplicates, or an error results if an Id
in
the supplied list is not found or inaccessible. Otherwise,
inaccessible Signals
may be omitted from the list and
may present the elements in any order including returning a unique
set.
In active mode, signals are returned that are currently active. In any
status mode, active and inactive signals are returned.signalIds
- the list of Ids
to retrieve Signal
listNotFoundException
- an Id was
not foundNullArgumentException
- signalIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SignalList getSignalsByGenusType(Type signalGenusType) throws OperationFailedException, PermissionDeniedException
SignalList
corresponding to the given signal
genus Type
which does not include signals of types
derived from the specified Type.
In plenary mode, the returned list contains all known
signals or an error results. Otherwise, the returned list may contain
only those signals that are accessible through this session.
In active mode, signals are returned that are currently active. In any
status mode, active and inactive signals are returned.signalGenusType
- a signal genus type Signal
listNullArgumentException
- signalGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SignalList getSignalsByParentGenusType(Type signalGenusType) throws OperationFailedException, PermissionDeniedException
SignalList
corresponding to the given signal
genus Type
and include any additional signals with
genus types derived from the specified Type.
In plenary mode, the returned list contains all known
signals or an error results. Otherwise, the returned list may contain
only those signals that are accessible through this session.
In active mode, signals are returned that are currently active. In any
status mode, active and inactive signals are returned.signalGenusType
- a signal genus type Signal
listNullArgumentException
- signalGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SignalList getSignalsByRecordType(Type signalRecordType) throws OperationFailedException, PermissionDeniedException
SignalList
containing the given signal record
Type.
In plenary mode, the returned list contains all known signals or an
error results. Otherwise, the returned list may contain only those
signals that are accessible through this session.
In active mode, signals are returned that are currently active. In any
status mode, active and inactive signals are returned.signalRecordType
- a signal record type Signal
listNullArgumentException
- signalRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SignalList getSignalsForPath(Id pathId) throws OperationFailedException, PermissionDeniedException
SignalList
containing the given path.
In plenary mode, the returned list contains all known signals or an
error results. Otherwise, the returned list may contain only those
signals that are accessible through this session.
In active mode, signals are returned that are currently active. In any
status mode, active and inactive signals are returned.pathId
- a path Id
Signal
listNullArgumentException
- pathId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SignalList getSignalsForPathAtCoordinate(Id pathId, Coordinate coordinate, Distance distance) throws OperationFailedException, PermissionDeniedException
SignalList
containing the given path between the
given coordinates inclusive.
In plenary mode, the returned list contains all known signals or an
error results. Otherwise, the returned list may contain only those
signals that are accessible through this session.
In active mode, signals are returned that are currently active. In any
status mode, active and inactive signals are returned.pathId
- a path Id
coordinate
- starting coordinatedistance
- a distance from coordinate Signal
listNullArgumentException
- pathId, coordinate
or distance
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SignalList getSignals() throws OperationFailedException, PermissionDeniedException
Signals.
In plenary mode, the returned list contains all known signals or an
error results. Otherwise, the returned list may contain only those
signals that are accessible through this session.
In active mode, signals are returned that are currently active. In any
status mode, active and inactive signals are returned. Signals
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.