public interface ParameterProcessorLookupSession extends OsidSession
This session provides methods for retrieving
ParameterProcessors.
This session defines views that offer differing behaviors when retrieving multiple objects.
ParameterProcessors
with
the ParameterProcessorAdminSession.
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 |
canLookupParameterProcessors()
Tests if this user can perform
ParameterProcessors
lookups. |
Configuration |
getConfiguration()
Gets the
Configuration associated with this session. |
Id |
getConfigurationId()
Gets the
Configuration Id associated
with this session. |
ParameterProcessor |
getParameterProcessor(Id parameterProcessorId)
Gets the
ParameterProcessor specified by its Id. |
ParameterProcessorList |
getParameterProcessors()
Gets all
ParameterProcessors. |
ParameterProcessorList |
getParameterProcessorsByGenusType(Type parameterProcessorGenusType)
Gets a
ParameterProcessorList corresponding to the
given parameter processor genus Type which does not
include parameter processor of genus types derived from the specified
Type. |
ParameterProcessorList |
getParameterProcessorsByIds(IdList parameterProcessorIds)
Gets a
ParameterProcessorList corresponding to the
given IdList. |
ParameterProcessorList |
getParameterProcessorsByParentGenusType(Type parameterProcessorGenusType)
Gets a
ParameterProcessorList corresponding to the
given parameter processor genus Type and include any
additional parameter processor with genus types derived from the
specified Type. |
ParameterProcessorList |
getParameterProcessorsByRecordType(Type parameterProcessorRecordType)
Gets a
ParameterProcessorList containing the given
parameter processor record Type. |
void |
useActiveParameterProcessorView()
Only active parameter processors are returned by methods in this
session.
|
void |
useAnyStatusParameterProcessorView()
All active and inactive parameter processors are returned by methods
in this session.
|
void |
useComparativeParameterProcessorView()
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 |
useFederatedConfigurationView()
Federates the view for methods in this session.
|
void |
useIsolatedConfigurationView()
Isolates the view for methods in this session.
|
void |
usePlenaryParameterProcessorView()
A complete view of the
ParameterProcessor returns is
desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getConfigurationId()
Configuration
Id
associated
with this session. Configuration Id
associated with this
sessionmandatory
- This method must be implemented. Configuration getConfiguration() throws OperationFailedException, PermissionDeniedException
Configuration
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupParameterProcessors()
ParameterProcessors
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 useComparativeParameterProcessorView()
mandatory
- This method is must be implemented. void usePlenaryParameterProcessorView()
ParameterProcessor
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 useFederatedConfigurationView()
mandatory
- This method is must be implemented. void useIsolatedConfigurationView()
mandatory
- This method is must be implemented. void useActiveParameterProcessorView()
mandatory
- This method is must be implemented. void useAnyStatusParameterProcessorView()
mandatory
- This method is must be implemented. ParameterProcessor getParameterProcessor(Id parameterProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ParameterProcessor
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
ParameterProcessor
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a ParameterProcessor
and retained for
compatibility.
In active mode, parameter processors are returned that are currently
active. In any status mode, active and inactive parameter processors
are returned.parameterProcessorId
- Id
of the
ParameterProcessor
NotFoundException
- parameterProcessorId
not foundNullArgumentException
- parameterProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. ParameterProcessorList getParameterProcessorsByIds(IdList parameterProcessorIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ParameterProcessorList
corresponding to the
given IdList.
In plenary mode, the returned list contains all of the
parameter processor 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 ParameterProcessors
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, parameter processors are returned that are currently
active. In any status mode, active and inactive parameter processors
are returned.parameterProcessorIds
- the list of Ids
to
retrieve ParameterProcessor
listNotFoundException
- an Id was
not foundNullArgumentException
- parameterProcessorIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ParameterProcessorList getParameterProcessorsByGenusType(Type parameterProcessorGenusType) throws OperationFailedException, PermissionDeniedException
ParameterProcessorList
corresponding to the
given parameter processor genus Type
which does not
include parameter processor of genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
parameter processor or an error results. Otherwise, the returned list
may contain only those parameter processor that are accessible through
this session.
In active mode, parameter processors are returned that are currently
active. In any status mode, active and inactive parameter processors
are returned.parameterProcessorGenusType
- a parameter processor genus type ParameterProcessor
listNullArgumentException
-
parameterProcessorGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ParameterProcessorList getParameterProcessorsByParentGenusType(Type parameterProcessorGenusType) throws OperationFailedException, PermissionDeniedException
ParameterProcessorList
corresponding to the
given parameter processor genus Type
and include any
additional parameter processor with genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
parameter processor or an error results. Otherwise, the returned list
may contain only those parameter processor that are accessible through
this session.
In active mode, parameter processors are returned that are currently
active. In any status mode, active and inactive parameter processors
are returned.parameterProcessorGenusType
- a parameter processor genus type ParameterProcessor
listNullArgumentException
-
parameterProcessorGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ParameterProcessorList getParameterProcessorsByRecordType(Type parameterProcessorRecordType) throws OperationFailedException, PermissionDeniedException
ParameterProcessorList
containing the given
parameter processor record Type.
In plenary mode, the returned list contains all known
parameter processor or an error results. Otherwise, the returned list
may contain only those parameter processor that are accessible through
this session.
In active mode, parameter processors are returned that are currently
active. In any status mode, active and inactive parameter processors
are returned.parameterProcessorRecordType
- a parameter processor record type ParameterProcessor
listNullArgumentException
-
parameterProcessorRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ParameterProcessorList getParameterProcessors() throws OperationFailedException, PermissionDeniedException
ParameterProcessors.
In plenary mode, the returned list contains all known parameter
processor or an error results. Otherwise, the returned list may
contain only those parameter processor that are accessible through
this session.
In active mode, parameter processors are returned that are currently
active. In any status mode, active and inactive parameter processors
are returned. ParameterProcessor
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.