public interface ObstacleEnablerLookupSession extends OsidSession
This session provides methods for retrieving ObstacleEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
ObstacleEnablers
with the
ObstacleEnablerAdminSession.
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 |
canLookupObstacleEnablers()
Tests if this user can perform
ObstacleEnablers
lookups. |
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
ObstacleEnabler |
getObstacleEnabler(Id obstacleEnablerId)
Gets the
ObstacleEnabler specified by its Id. |
ObstacleEnablerList |
getObstacleEnablers()
Gets all
ObstacleEnablers. |
ObstacleEnablerList |
getObstacleEnablersByGenusType(Type obstacleEnablerGenusType)
Gets an
ObstacleEnablerList corresponding to the given
obstacle enabler genus Type which does not include
obstacle enabler of genus types derived from the specified
Type. |
ObstacleEnablerList |
getObstacleEnablersByIds(IdList obstacleEnablerIds)
Gets an
ObstacleEnablerList corresponding to the given
IdList. |
ObstacleEnablerList |
getObstacleEnablersByParentGenusType(Type obstacleEnablerGenusType)
Gets an
ObstacleEnablerList corresponding to the given
obstacle enabler genus Type and include any additional
obstacle enabler with genus types derived from the specified
Type. |
ObstacleEnablerList |
getObstacleEnablersByRecordType(Type obstacleEnablerRecordType)
Gets an
ObstacleEnablerList containing the given
obstacle enabler record Type. |
ObstacleEnablerList |
getObstacleEnablersOnDate(DateTime from,
DateTime to)
Gets an
ObstacleEnablerList that are effective for the
entire given date range inclusive but not confined to the date range
for any agent. |
ObstacleEnablerList |
getObstacleEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets an
ObstacleEnablerList that are effective for the
entire given date range inclusive but not confined to the date range
and evaluated against the given agent. |
void |
useActiveObstacleEnablerView()
Only active obstacle enablers are returned by methods in this session.
|
void |
useAnyStatusObstacleEnablerView()
All active and inactive obstacle enablers are returned by methods in
this session.
|
void |
useComparativeObstacleEnablerView()
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 |
usePlenaryObstacleEnablerView()
A complete view of the
ObstacleEnabler 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 canLookupObstacleEnablers()
ObstacleEnablers
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 useComparativeObstacleEnablerView()
mandatory
- This method is must be implemented. void usePlenaryObstacleEnablerView()
ObstacleEnabler
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 useActiveObstacleEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusObstacleEnablerView()
mandatory
- This method is must be implemented. ObstacleEnabler getObstacleEnabler(Id obstacleEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ObstacleEnabler
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
ObstacleEnabler
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to an ObstacleEnabler
and retained for
compatibility.
In active mode, obstacle enablers are returned that are currently
active. In any status mode, active and inactive obstacle enablers are
returned.obstacleEnablerId
- Id
of the
ObstacleEnabler
NotFoundException
- obstacleEnablerId
not foundNullArgumentException
- obstacleEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. ObstacleEnablerList getObstacleEnablersByIds(IdList obstacleEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ObstacleEnablerList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
obstacle 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 ObstacleEnablers
may be omitted from the
list and may present the elements in any order including returning a
unique set.
In active mode, obstacle enablers are returned that are currently
active. In any status mode, active and inactive obstacle enablers are
returned.obstacleEnablerIds
- the list of Ids
to retrieve ObstacleEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
- obstacleEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObstacleEnablerList getObstacleEnablersByGenusType(Type obstacleEnablerGenusType) throws OperationFailedException, PermissionDeniedException
ObstacleEnablerList
corresponding to the given
obstacle enabler genus Type
which does not include
obstacle enabler of genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
obstacle enabler or an error results. Otherwise, the returned list may
contain only those obstacle enabler that are accessible through this
session.
In active mode, obstacle enablers are returned that are currently
active. In any status mode, active and inactive obstacle enablers are
returned.obstacleEnablerGenusType
- an obstacle enabler genus type ObstacleEnabler
listNullArgumentException
- obstacleEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObstacleEnablerList getObstacleEnablersByParentGenusType(Type obstacleEnablerGenusType) throws OperationFailedException, PermissionDeniedException
ObstacleEnablerList
corresponding to the given
obstacle enabler genus Type
and include any additional
obstacle enabler with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
obstacle enabler or an error results. Otherwise, the returned list may
contain only those obstacle enabler that are accessible through this
session.
In active mode, obstacle enablers are returned that are currently
active. In any status mode, active and inactive obstacle enablers are
returned.obstacleEnablerGenusType
- an obstacle enabler genus type ObstacleEnabler
listNullArgumentException
- obstacleEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObstacleEnablerList getObstacleEnablersByRecordType(Type obstacleEnablerRecordType) throws OperationFailedException, PermissionDeniedException
ObstacleEnablerList
containing the given
obstacle enabler record Type.
In plenary mode, the returned list contains all known
obstacle enabler or an error results. Otherwise, the returned list may
contain only those obstacle enabler that are accessible through this
session.
In active mode, obstacle enablers are returned that are currently
active. In any status mode, active and inactive obstacle enablers are
returned.obstacleEnablerRecordType
- an obstacle enabler record type ObstacleEnabler
listNullArgumentException
-
obstacleEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObstacleEnablerList getObstacleEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ObstacleEnablerList
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 obstacle
enablers or an error results. Otherwise, the returned list may contain
only those obstacle enablers that are accessible through this session.
In active mode, obstacle enablers are returned that are currently
active in addition to being effective during the given date range. In
any status mode, active and inactive obstacle enablers are returned.from
- a start dateto
- an end date ObstacleEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObstacleEnablerList getObstacleEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ObstacleEnablerList
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 obstacle
enablers or an error results. Otherwise, the returned list may contain
only those obstacle enablers that are accessible through this session.
In active mode, obstacle enablers are returned that are currently
active in addition to being effective during the given date range. In
any status mode, active and inactive obstacle enablers are returned.agentId
- an agent Id
from
- a start dateto
- an end date ObstacleEnabler
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. ObstacleEnablerList getObstacleEnablers() throws OperationFailedException, PermissionDeniedException
ObstacleEnablers.
In plenary mode, the returned list contains all known obstacle enabler
or an error results. Otherwise, the returned list may contain only
those obstacle enabler that are accessible through this session.
In active mode, obstacle enablers are returned that are currently
active. In any status mode, active and inactive obstacle enablers are
returned. ObstacleEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.