public interface SignalEnablerLookupSession extends OsidSession
This session provides methods for retrieving SignalEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
SignalEnablers
with the SignalEnablerAdminSession.
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 |
canLookupSignalEnablers()
Tests if this user can perform
SignalEnablers lookups. |
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
SignalEnabler |
getSignalEnabler(Id signalEnablerId)
Gets the
SignalEnabler specified by its Id. |
SignalEnablerList |
getSignalEnablers()
Gets all
SignalEnablers. |
SignalEnablerList |
getSignalEnablersByGenusType(Type signalEnablerGenusType)
Gets a
SignalEnablerList corresponding to the given
signal enabler genus Type which does not include signal
enabler of genus types derived from the specified Type. |
SignalEnablerList |
getSignalEnablersByIds(IdList signalEnablerIds)
Gets a
SignalEnablerList corresponding to the given
IdList. |
SignalEnablerList |
getSignalEnablersByParentGenusType(Type signalEnablerGenusType)
Gets a
SignalEnablerList corresponding to the given
signal enabler genus Type and include any additional
signal enabler with genus types derived from the specified
Type. |
SignalEnablerList |
getSignalEnablersByRecordType(Type signalEnablerRecordType)
Gets a
SignalEnablerList containing the given signal
enabler record Type. |
SignalEnablerList |
getSignalEnablersOnDate(DateTime from,
DateTime to)
Gets a
SignalEnablerList that are effective for the
entire given date range inclusive but not confined to the date range
for any agent. |
SignalEnablerList |
getSignalEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets a
SignalEnablerList that are effective for the
entire given date range inclusive but not confined to the date range
and evaluated against the given agent. |
void |
useActiveSignalEnablerView()
Only active signal enablers are returned by methods in this session.
|
void |
useAnyStatusSignalEnablerView()
All active and inactive signal enablers are returned by methods in
this session.
|
void |
useComparativeSignalEnablerView()
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 |
usePlenarySignalEnablerView()
A complete view of the
SignalEnabler 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 canLookupSignalEnablers()
SignalEnablers
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 useComparativeSignalEnablerView()
mandatory
- This method is must be implemented. void usePlenarySignalEnablerView()
SignalEnabler
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 useActiveSignalEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusSignalEnablerView()
mandatory
- This method is must be implemented. SignalEnabler getSignalEnabler(Id signalEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SignalEnabler
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
SignalEnabler
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a SignalEnabler
and retained for
compatibility.
In active mode, signal enablers are returned that are currently
active. In any status mode, active and inactive signal enablers are
returned.signalEnablerId
- Id
of the SignalEnabler
NotFoundException
- signalEnablerId
not
foundNullArgumentException
- signalEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. SignalEnablerList getSignalEnablersByIds(IdList signalEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
SignalEnablerList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
signal enabler 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 SignalEnablers
may be omitted from the
list and may present the elements in any order including returning a
unique set.
In active mode, signal enablers are returned that are currently
active. In any status mode, active and inactive signal enablers are
returned.signalEnablerIds
- the list of Ids
to retrieve SignalEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
- signalEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SignalEnablerList getSignalEnablersByGenusType(Type signalEnablerGenusType) throws OperationFailedException, PermissionDeniedException
SignalEnablerList
corresponding to the given
signal enabler genus Type
which does not include signal
enabler of genus types derived from the specified Type.
In plenary mode, the returned list contains all known
signal enabler or an error results. Otherwise, the returned list may
contain only those signal enabler that are accessible through this
session.
In active mode, signal enablers are returned that are currently
active. In any status mode, active and inactive signal enablers are
returned.signalEnablerGenusType
- a signal enabler genus type SignalEnabler
listNullArgumentException
- signalEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SignalEnablerList getSignalEnablersByParentGenusType(Type signalEnablerGenusType) throws OperationFailedException, PermissionDeniedException
SignalEnablerList
corresponding to the given
signal enabler genus Type
and include any additional
signal enabler with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
signal enabler or an error results. Otherwise, the returned list may
contain only those signal enabler that are accessible through this
session.
In active mode, signal enablers are returned that are currently
active. In any status mode, active and inactive signal enablers are
returned.signalEnablerGenusType
- a signal enabler genus type SignalEnabler
listNullArgumentException
- signalEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SignalEnablerList getSignalEnablersByRecordType(Type signalEnablerRecordType) throws OperationFailedException, PermissionDeniedException
SignalEnablerList
containing the given signal
enabler record Type.
In plenary mode, the returned list contains all known
signal enabler or an error results. Otherwise, the returned list may
contain only those signal enabler that are accessible through this
session.
In active mode, signal enablers are returned that are currently
active. In any status mode, active and inactive signal enablers are
returned.signalEnablerRecordType
- a signal enabler record type SignalEnabler
listNullArgumentException
- signalEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SignalEnablerList getSignalEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
SignalEnablerList
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 signal enablers
or an error results. Otherwise, the returned list may contain only
those signal enablers that are accessible through this session.
In active mode, signal enablers are returned that are currently active
in addition to being effective during the given date range. In any
status mode, active and inactive signal enablers are returned.from
- a start dateto
- an end date SignalEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SignalEnablerList getSignalEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
SignalEnablerList
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 signal enablers
or an error results. Otherwise, the returned list may contain only
those signal enablers that are accessible through this session.
In active mode, signal enablers are returned that are currently active
in addition to being effective during the given date range. In any
status mode, active and inactive signal enablers are returned.agentId
- an agent Id
from
- a start dateto
- an end date SignalEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- agentId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SignalEnablerList getSignalEnablers() throws OperationFailedException, PermissionDeniedException
SignalEnablers.
In plenary mode, the returned list contains all known signal enabler
or an error results. Otherwise, the returned list may contain only
those signal enabler that are accessible through this session.
In active mode, signal enablers are returned that are currently
active. In any status mode, active and inactive signal enablers are
returned. SignalEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.