public interface InputEnablerLookupSession extends OsidSession
This session provides methods for retrieving InputEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
InputEnablers
with the InputEnablerAdminSession.
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 useFederatedDistributorView()
and
useIsolatedDistributorView()
behave as a radio group and one
should be selected before invoking the methods in this session.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupInputEnablers()
Tests if this user can perform
InputEnablers lookups. |
InputEnabler |
getInputEnabler(Id inputEnablerId)
Gets the
InputEnabler specified by its Id. |
InputEnablerList |
getInputEnablers()
Gets all
InputEnablers. |
InputEnablerList |
getInputEnablersByGenusType(Type inputEnablerGenusType)
Gets an
InputEnablerList corresponding to the given
input enabler genus Type which does not include input
enablers of genus types derived from the specified Type. |
InputEnablerList |
getInputEnablersByIds(IdList inputEnablerIds)
Gets an
InputEnablerList corresponding to the given
IdList. |
InputEnablerList |
getInputEnablersByParentGenusType(Type inputEnablerGenusType)
Gets an
InputEnablerList corresponding to the given
input enabler genus Type and include any additional
input enablers with genus types derived from the specified
Type. |
InputEnablerList |
getInputEnablersByRecordType(Type inputEnablerRecordType)
Gets an
InputEnablerList containing the given input
enabler record Type. |
InputEnablerList |
getInputEnablersOnDate(DateTime from,
DateTime to)
Gets an
InputEnablerList effective within the given
date range. |
InputEnablerList |
getInputEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets an
InputEnablerList effective during the entire
given date range but not confined to the date range and evaluated
against the given agent. |
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
void |
useActiveInputEnablerView()
Only active input enablers are returned by methods in this session.
|
void |
useAnyStatusInputEnablerView()
All active and inactive input enablers are returned by methods in this
session.
|
void |
useComparativeInputEnablerView()
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 |
useFederatedSystemView()
Federates the view for methods in this session.
|
void |
useIsolatedSystemView()
Isolates the view for methods in this session.
|
void |
usePlenaryInputEnablerView()
A complete view of the
InputEnabler returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getSystemId()
System
Id
associated with this
session. System Id
associated with this sessionmandatory
- This method must be implemented. System getSystem() throws OperationFailedException, PermissionDeniedException
System
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupInputEnablers()
InputEnablers
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 useComparativeInputEnablerView()
mandatory
- This method is must be implemented. void usePlenaryInputEnablerView()
InputEnabler
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 useFederatedSystemView()
mandatory
- This method is must be implemented. void useIsolatedSystemView()
mandatory
- This method is must be implemented. void useActiveInputEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusInputEnablerView()
mandatory
- This method is must be implemented. InputEnabler getInputEnabler(Id inputEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
InputEnabler
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
InputEnabler
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to an InputEnabler
and retained for
compatibility.
In active mode, input enablers are returned that are currently active.
In any status mode, active and inactive input enablers are returned.inputEnablerId
- Id
of the InputEnabler
NotFoundException
- inputEnablerId
not
foundNullArgumentException
- inputEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. InputEnablerList getInputEnablersByIds(IdList inputEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
InputEnablerList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
input enablers 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 InputEnablers
may be omitted from the list
and may present the elements in any order including returning a unique
set.
In active mode, input enablers are returned that are currently active.
In any status mode, active and inactive input enablers are returned.inputEnablerIds
- the list of Ids
to retrieve InputEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
- inputEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InputEnablerList getInputEnablersByGenusType(Type inputEnablerGenusType) throws OperationFailedException, PermissionDeniedException
InputEnablerList
corresponding to the given
input enabler genus Type
which does not include input
enablers of genus types derived from the specified Type.
In plenary mode, the returned list contains all known
input enablers or an error results. Otherwise, the returned list may
contain only those input enablers that are accessible through this
session.
In active mode, input enablers are returned that are currently active.
In any status mode, active and inactive input enablers are returned.inputEnablerGenusType
- an input enabler genus type InputEnabler
listNullArgumentException
- inputEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InputEnablerList getInputEnablersByParentGenusType(Type inputEnablerGenusType) throws OperationFailedException, PermissionDeniedException
InputEnablerList
corresponding to the given
input enabler genus Type
and include any additional
input enablers with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
input enablers or an error results. Otherwise, the returned list may
contain only those input enablers that are accessible through this
session.
In active mode, input enablers are returned that are currently active.
In any status mode, active and inactive input enablers are returned.inputEnablerGenusType
- an input enabler genus type InputEnabler
listNullArgumentException
- inputEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InputEnablerList getInputEnablersByRecordType(Type inputEnablerRecordType) throws OperationFailedException, PermissionDeniedException
InputEnablerList
containing the given input
enabler record Type.
In plenary mode, the returned list contains all known
input enablers or an error results. Otherwise, the returned list may
contain only those input enablers that are accessible through this
session.
In active mode, input enablers are returned that are currently active.
In any status mode, active and inactive input enablers are returned.inputEnablerRecordType
- an input enabler record type InputEnabler
listNullArgumentException
- inputEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InputEnablerList getInputEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
InputEnablerList
effective within the given
date range.
In plenary mode, the returned list contains all known
input enablers or an error results. Otherwise, the returned list may
contain only those input enablers that are accessible through this
session.
In active mode, input enablers are returned that are currently active.
In any status mode, active and inactive input enablers are returned.from
- a start dateto
- an end date InputEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InputEnablerList getInputEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
InputEnablerList
effective during the entire
given date range but not confined to the date range and evaluated
against the given agent.
In plenary mode, the returned list contains all known
input enablers or an error results. Otherwise, the returned list may
contain only those input enablers that are accessible through this
session.
In active mode, input enablers are returned that are currently active.
In any status mode, active and inactive input enablers are returned.agentId
- an agent Idfrom
- a start dateto
- an end date InputEnabler
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. InputEnablerList getInputEnablers() throws OperationFailedException, PermissionDeniedException
InputEnablers.
In plenary mode, the returned list contains all known input enablers
or an error results. Otherwise, the returned list may contain only
those input enablers that are accessible through this session.
In active mode, input enablers are returned that are currently active.
In any status mode, active and inactive input enablers are returned. InputEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.