public interface InputLookupSession extends OsidSession
This session provides methods for retrieving Input
objects. The Input
represents a fixed connection between
two Scenes.
This session defines views that offer differing behaviors when retrieving multiple objects.
Inputs
with the InputAdminSession.
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 useFederatedSystemView()
and
useIsolatedSystemView()
behave as a radio group and one should be
selected before invoking any lookup methods.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupInputs()
Tests if this user can perform
Input lookups. |
Input |
getInput(Id inputId)
Gets the
Input specified by its Id. |
InputList |
getInputs()
Gets all
Inputs. |
InputList |
getInputsByGenusType(Type inputGenusType)
Gets a
InputList corresponding to the given input genus
Type which does not include inputs of genus types
derived from the specified Type. |
InputList |
getInputsByIds(IdList inputIds)
Gets a
InputList corresponding to the given
IdList. |
InputList |
getInputsByParentGenusType(Type inputGenusType)
Gets a
InputList corresponding to the given input genus
Type and include any additional inputs with genus types
derived from the specified Type. |
InputList |
getInputsByRecordType(Type inputRecordType)
Gets a
InputList containing the given input record
Type. |
InputList |
getInputsForController(Id controllerId)
Gets a list of inputs for a controller.
|
InputList |
getInputsForControllerOnDate(Id controllerId,
DateTime from,
DateTime to)
Gets a list of inputs for a controller and effective during the entire
given date range inclusive but not confined to the date range.
|
InputList |
getInputsForDevice(Id deviceId)
Gets a list of inputs for a device.
|
InputList |
getInputsForDeviceAndController(Id deviceId,
Id controllerId)
Gets a list of inputs for a device and controller.
|
InputList |
getInputsForDeviceAndControllerOnDate(Id deviceId,
Id controllerId,
DateTime from,
DateTime to)
Gets a list of inputs for the device and controller and effective
during the entire given date range inclusive but not confined to the
date range.
|
InputList |
getInputsForDeviceOnDate(Id deviceId,
DateTime from,
DateTime to)
Gets a list of inputs for a device and effective during the entire
given date range inclusive but not confined to the date range.
|
InputList |
getInputsOnDate(DateTime from,
DateTime to)
Gets a list of inputs effective during the entire given date range
inclusive but not confined to the date range.
|
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
void |
useAnyEffectiveInputView()
All input of any effective dates are returned by methods in this
session.
|
void |
useComparativeInputView()
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 |
useEffectiveInputView()
Only inputs whose effective dates are current are returned by methods
in this session.
|
void |
useFederatedSystemView()
Federates the view for methods in this session.
|
void |
useIsolatedSystemView()
Isolates the view for methods in this session.
|
void |
usePlenaryInputView()
A complete view of the
Input 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 canLookupInputs()
Input
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 useComparativeInputView()
mandatory
- This method is must be implemented. void usePlenaryInputView()
Input
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 useEffectiveInputView()
mandatory
- This method is must be implemented. void useAnyEffectiveInputView()
mandatory
- This method is must be implemented. Input getInput(Id inputId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Input
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Input
may have a different Id
than requested,
such as the case where a duplicate Id
was assigned to a
Input
and retained for compatibility.
In effective mode, inputs are returned whose effective dates fall
within the current date inclusive. In any effective mode, effective
and expired inputs are returned.inputId
- Id
of the Input
NotFoundException
- inputId
not foundNullArgumentException
- inputId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. InputList getInputsByIds(IdList inputIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
InputList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
inputs 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 Inputs
may be omitted from the list and
may present the elements in any order including returning a unique
set.
In effective mode, inputs are returned whose effective dates fall
within the current date inclusive. In any effective mode, effective
and expired inputs are returned.inputIds
- the list of Ids
to retrieve Input
listNotFoundException
- an Id
was not foundNullArgumentException
- inputIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InputList getInputsByGenusType(Type inputGenusType) throws OperationFailedException, PermissionDeniedException
InputList
corresponding to the given input genus
Type
which does not include inputs of genus types
derived from the specified Type.
In plenary mode, the returned list contains all known
inputs or an error results. Otherwise, the returned list may contain
only those inputs that are accessible through this session.
In effective mode, inputs are returned whose effective dates fall
within the current date inclusive. In any effective mode, effective
and expired inputs are returned.inputGenusType
- an input genus type Input
listNullArgumentException
- inputGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InputList getInputsByParentGenusType(Type inputGenusType) throws OperationFailedException, PermissionDeniedException
InputList
corresponding to the given input genus
Type
and include any additional inputs with genus types
derived from the specified Type.
In plenary mode, the returned list contains all known
inputs or an error results. Otherwise, the returned list may contain
only those inputs that are accessible through this session.
In effective mode, inputs are returned whose effective dates fall
within the current date inclusive. In any effective mode, effective
and expired inputs are returned.inputGenusType
- an input genus type Input
listNullArgumentException
- inputGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InputList getInputsByRecordType(Type inputRecordType) throws OperationFailedException, PermissionDeniedException
InputList
containing the given input record
Type.
In plenary mode, the returned list contains all known
inputs or an error results. Otherwise, the returned list may contain
only those inputs that are accessible through this session.
In effective mode, inputs are returned whose effective dates fall
within the current date inclusive. In any effective mode, effective
and expired inputs are returned.inputRecordType
- an input record type Input
listNullArgumentException
- inputRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InputList getInputsOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
inputs or an error results. Otherwise, the returned list may contain
only those inputs that are accessible through this session.
In effective mode, inputs are returned that are currently effective in
addition to being effective in the given date range. In any effective
mode, effective inputs and those currently expired are returned.from
- start of date rangeto
- end of date range Input
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InputList getInputsForDevice(Id deviceId) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
inputs or an error results. Otherwise, the returned list may contain
only those inputs that are accessible through this session.
In effective mode, inputs are returned that are currently effective.
In any effective mode, effective inputs and those currently expired
are returned.deviceId
- a device Id
Input
listNullArgumentException
- deviceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InputList getInputsForDeviceOnDate(Id deviceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
inputs or an error results. Otherwise, the returned list may contain
only those inputs that are accessible through this session.
In effective mode, inputs are returned that are currently effective in
addition to being effective in the given date range. In any effective
mode, effective inputs and those currently expired are returned.deviceId
- a device Id
from
- start of date rangeto
- end of date range Input
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- deviceId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InputList getInputsForController(Id controllerId) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
inputs or an error results. Otherwise, the returned list may contain
only those inputs that are accessible through this session.
In effective mode, inputs are returned that are currently effective.
In any effective mode, effective inputs and those currently expired
are returned.controllerId
- a controller Id
Input
listNullArgumentException
- controllerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InputList getInputsForControllerOnDate(Id controllerId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
inputs or an error results. Otherwise, the returned list may contain
only those inputs that are accessible through this session.
In effective mode, inputs are returned that are currently effective in
addition to being effective in the given date range. In any effective
mode, effective inputs and those currently expired are returned.controllerId
- a controller Id
from
- start of date rangeto
- end of date range Input
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- controllerId, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InputList getInputsForDeviceAndController(Id deviceId, Id controllerId) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
inputs or an error results. Otherwise, the returned list may contain
only those inputs that are accessible through this session.
In effective mode, inputs are returned that are currently effective.
In any effective mode, effective inputs and those currently expired
are returned.deviceId
- a device Id
controllerId
- a controller Id
Input
listNullArgumentException
- deviceId
or
controllerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InputList getInputsForDeviceAndControllerOnDate(Id deviceId, Id controllerId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
inputs or an error results. Otherwise, the returned list may contain
only those inputs that are accessible through this session.
In effective mode, inputs are returned that are currently effective in
addition to being effective in the given date range. In any effective
mode, effective inputs and those currently expired are returned.deviceId
- a device Id
controllerId
- a controller Id
from
- start of date rangeto
- end of date range Input
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- device, controllerId,
from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InputList getInputs() throws OperationFailedException, PermissionDeniedException
Inputs.
In plenary mode, the returned list contains all known inputs or an
error results. Otherwise, the returned list may contain only those
inputs that are accessible through this session.
In effective mode, inputs are returned that are currently effective.
In any effective mode, effective inputs and those currently expired
are returned. Inputs
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.