public interface ParameterProcessorEnablerLookupSession extends OsidSession
This session provides methods for retrieving
ParameterProcessorEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
ParameterProcessorEnablers
with the
ParameterProcessorEnablerAdminSession.
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 |
canLookupParameterProcessorEnablers()
Tests if this user can perform
ParameterProcessorEnablers
lookups. |
Configuration |
getConfiguration()
Gets the
Configuration associated with this session. |
Id |
getConfigurationId()
Gets the
Configuration Id associated
with this session. |
ParameterProcessorEnabler |
getParameterProcessorEnabler(Id parameterProcessorEnablerId)
Gets the
ParameterProcessorEnabler specified by its
Id. |
ParameterProcessorEnablerList |
getParameterProcessorEnablers()
Gets all
ParameterProcessorEnablers. |
ParameterProcessorEnablerList |
getParameterProcessorEnablersByGenusType(Type parameterProcessorEnablerGenusType)
Gets a
ParameterProcessorEnablerList corresponding to
the given parameter processor enabler genus Type which
does not include parameter processor enablers of genus types derived
from the specified Type. |
ParameterProcessorEnablerList |
getParameterProcessorEnablersByIds(IdList parameterProcessorEnablerIds)
Gets a
ParameterProcessorEnablerList corresponding to
the given IdList. |
ParameterProcessorEnablerList |
getParameterProcessorEnablersByParentGenusType(Type parameterProcessorEnablerGenusType)
Gets a
ParameterProcessorEnablerList corresponding to
the given parameter processor enabler genus Type and
include any additional parameter processor enablers with genus types
derived from the specified Type. |
ParameterProcessorEnablerList |
getParameterProcessorEnablersByRecordType(Type parameterProcessorEnablerRecordType)
Gets a
ParameterProcessorEnablerList containing the
given parameter processor enabler record Type. |
ParameterProcessorEnablerList |
getParameterProcessorEnablersOnDate(DateTime from,
DateTime to)
Gets a
ParameterProcessorEnablerList that are effective
for the entire given date range but not confined to the date range. |
ParameterProcessorEnablerList |
getParameterProcessorEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets a
ParameterProcessorEnablerList that are effective
for the entire given date range but not confined to the date range and
evaluated against the given agent. |
void |
useActiveParameterProcessorEnablerView()
Only active parameter processor enablers are returned by methods in
this session.
|
void |
useAnyStatusParameterProcessorEnablerView()
All active and inactive parameter processor enablers are returned by
methods in this session.
|
void |
useComparativeParameterProcessorEnablerView()
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 |
usePlenaryParameterProcessorEnablerView()
A complete view of the
ParameterProcessorEnabler
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 canLookupParameterProcessorEnablers()
ParameterProcessorEnablers
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 useComparativeParameterProcessorEnablerView()
mandatory
- This method is must be implemented. void usePlenaryParameterProcessorEnablerView()
ParameterProcessorEnabler
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 useActiveParameterProcessorEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusParameterProcessorEnablerView()
mandatory
- This method is must be implemented. ParameterProcessorEnabler getParameterProcessorEnabler(Id parameterProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ParameterProcessorEnabler
specified by its
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
ParameterProcessorEnabler
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to a ParameterProcessorEnabler
and
retained for compatibility.
In active mode, parameter processor enablers are returned that are
currently active. In any status mode, active and inactive parameter
processor enablers are returned.parameterProcessorEnablerId
- Id
of the
ParameterProcessorEnabler
NotFoundException
- parameterProcessorEnablerId
not foundNullArgumentException
-
parameterProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. ParameterProcessorEnablerList getParameterProcessorEnablersByIds(IdList parameterProcessorEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ParameterProcessorEnablerList
corresponding to
the given IdList.
In plenary mode, the returned list contains all of the
parameter processor 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
ParameterProcessorEnablers
may be omitted from the list and
may present the elements in any order including returning a unique
set.
In active mode, parameter processor enablers are returned that are
currently active. In any status mode, active and inactive parameter
processor enablers are returned.parameterProcessorEnablerIds
- the list of Ids
to
retrieve ParameterProcessorEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
-
parameterProcessorEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ParameterProcessorEnablerList getParameterProcessorEnablersByGenusType(Type parameterProcessorEnablerGenusType) throws OperationFailedException, PermissionDeniedException
ParameterProcessorEnablerList
corresponding to
the given parameter processor enabler genus Type
which
does not include parameter processor enablers of genus types derived
from the specified Type.
In plenary mode, the returned list contains all known
parameter processor enablers or an error results. Otherwise, the
returned list may contain only those parameter processor enablers that
are accessible through this session.
In active mode, parameter processor enablers are returned that are
currently active. In any status mode, active and inactive parameter
processor enablers are returned.parameterProcessorEnablerGenusType
- a parameter processor
enabler genus type ParameterProcessorEnabler
listNullArgumentException
-
parameterProcessorEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ParameterProcessorEnablerList getParameterProcessorEnablersByParentGenusType(Type parameterProcessorEnablerGenusType) throws OperationFailedException, PermissionDeniedException
ParameterProcessorEnablerList
corresponding to
the given parameter processor enabler genus Type
and
include any additional parameter processor enablers with genus types
derived from the specified Type.
In plenary mode, the returned list contains all known
parameter processor enablers or an error results. Otherwise, the
returned list may contain only those parameter processor enablers that
are accessible through this session.
In active mode, parameter processor enablers are returned that are
currently active. In any status mode, active and inactive parameter
processor enablers are returned.parameterProcessorEnablerGenusType
- a parameter processor
enabler genus type ParameterProcessorEnabler
listNullArgumentException
-
parameterProcessorEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ParameterProcessorEnablerList getParameterProcessorEnablersByRecordType(Type parameterProcessorEnablerRecordType) throws OperationFailedException, PermissionDeniedException
ParameterProcessorEnablerList
containing the
given parameter processor enabler record Type.
In plenary mode, the returned list contains all known
parameter processor enablers or an error results. Otherwise, the
returned list may contain only those parameter processor enablers that
are accessible through this session.
In active mode, parameter processor enablers are returned that are
currently active. In any status mode, active and inactive parameter
processor enablers are returned.parameterProcessorEnablerRecordType
- a parameter processor
enabler record type ParameterProcessorEnabler
listNullArgumentException
-
parameterProcessorEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ParameterProcessorEnablerList getParameterProcessorEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ParameterProcessorEnablerList
that are effective
for the entire given date range but not confined to the date range.
In plenary mode, the returned list contains all known parameter
processor enablers or an error results. Otherwise, the returned list
may contain only those parameter processor enablers that are
accessible through this session.
In active mode, parameter processor enablers are returned that are
currently active. In any status mode, active and inactive parameter
processor enablers are returned.from
- a start dateto
- an end date ParameterProcessorEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ParameterProcessorEnablerList getParameterProcessorEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ParameterProcessorEnablerList
that are effective
for 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 parameter
processor enablers or an error results. Otherwise, the returned list
may contain only those parameter processor enablers that are
accessible through this session.
In active mode, parameter processor enablers are returned that are
currently active. In any status mode, active and inactive parameter
processor enablers are returned.agentId
- an agent Idfrom
- a start dateto
- an end date ParameterProcessorEnabler
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. ParameterProcessorEnablerList getParameterProcessorEnablers() throws OperationFailedException, PermissionDeniedException
ParameterProcessorEnablers.
In plenary mode, the returned list contains all known parameter
processor enablers or an error results. Otherwise, the returned list
may contain only those parameter processor enablers that are
accessible through this session.
In active mode, parameter processor enablers are returned that are
currently active. In any status mode, active and inactive parameter
processor enablers are returned. ParameterProcessorEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.