public interface ParameterLookupSession extends OsidSession
This session is used to retrieve parameters from a configuration registry of parameters.
This lookup session defines several views.
Parameters
with the
ParameterAdminSession.
The methods federateParameterView()
and
isolateParameterView()
behave as a radio group and one should be
selected before invoking any lookup methods.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupParameters()
Tests if this user can perform
Parameter lookups. |
Configuration |
getConfiguration()
Gets the
Configuration associated with this session. |
Id |
getConfigurationId()
Gets the
Configuration Id associated
with this session. |
Parameter |
getParameter(Id parameterId)
Gets the
Parameter specified by its Id. |
ParameterList |
getParameters()
Gets all
Parameters. |
ParameterList |
getParametersByGenusType(Type parameterGenusType)
Gets a
ParameterList corresponding to the given
parameter genus Type which does not include parameters
of genus types derived from the specified Type. |
ParameterList |
getParametersByIds(IdList parameterIds)
Gets a
ParameterList corresponding to the given
IdList. |
ParameterList |
getParametersByParentGenusType(Type parameterGenusType)
Gets a
ParameterList corresponding to the given
parameters genus Type and include any additional
parameters with genus types derived from the specified Type. |
ParameterList |
getParametersByRecordType(Type parameterRecordType)
Gets a
ParameterList corresponding to the given
parameter record Type which does not include parameters
of record types derived from the specified Type. |
void |
useActiveParameterView()
Only active parameters are returned by methods in this session.
|
void |
useAnyStatusParameterView()
All active and inactive parameters are returned by methods in this
session.
|
void |
useComparativeParameterView()
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 |
usePlenaryParameterView()
A complete view of the
Parameter 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. Configuration
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupParameters()
Parameter
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 useComparativeParameterView()
mandatory
- This method is must be implemented. void usePlenaryParameterView()
Parameter
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 useActiveParameterView()
mandatory
- This method is must be implemented. void useAnyStatusParameterView()
mandatory
- This method is must be implemented. Parameter getParameter(Id parameterId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Parameter
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Parameter
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a Parameter
and retained for compatibility.
In active mode, parameters are returned that are currently active. In
any status mode, active and inactive parameters are returned.parameterId
- the Id
of the Parameter
to retrieve Parameter
NotFoundException
- no Parameter
found
with the given Id
NullArgumentException
- parameterId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ParameterList getParametersByIds(IdList parameterIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ParameterList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
parameters 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 Parameters
may be omitted from the list
and may present the elements in any order including returning a unique
set.
In active mode, parameters are returned that are currently active. In
any status mode, active and inactive parameters are returned.parameterIds
- the list of Ids
to retrieve Parameter
listNotFoundException
- an Id was
not foundNullArgumentException
- parameterIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ParameterList getParametersByGenusType(Type parameterGenusType) throws OperationFailedException, PermissionDeniedException
ParameterList
corresponding to the given
parameter genus Type
which does not include parameters
of genus types derived from the specified Type.
In plenary mode, the returned list contains all known
parameters or an error results. Otherwise, the returned list may
contain only those parameters that are accessible through this
session.
In active mode, parameters are returned that are currently active. In
any status mode, active and inactive parameters are returned.parameterGenusType
- a parameter genus type Parameter list
NullArgumentException
- parameterGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ParameterList getParametersByParentGenusType(Type parameterGenusType) throws OperationFailedException, PermissionDeniedException
ParameterList
corresponding to the given
parameters genus Type
and include any additional
parameters with genus types derived from the specified Type.
In plenary mode, the returned list contains all known
parameters or an error results. Otherwise, the returned list may
contain only those parameters that are accessible through this
session.
In active mode, parameters are returned that are currently active. In
any status mode, active and inactive parameters are returned.parameterGenusType
- a parameter genus type Parameter list
NullArgumentException
- parameterGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ParameterList getParametersByRecordType(Type parameterRecordType) throws OperationFailedException, PermissionDeniedException
ParameterList
corresponding to the given
parameter record Type
which does not include parameters
of record types derived from the specified Type.
In plenary mode, the returned list contains all known
parameters or an error results. Otherwise, the returned list may
contain only those parameters that are accessible through this
session.
In active mode, parameters are returned that are currently active. In
any status mode, active and inactive parameters are returned.parameterRecordType
- a parameter type Parameter
listNullArgumentException
- parameterRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ParameterList getParameters() throws OperationFailedException, PermissionDeniedException
Parameters.
In plenary mode, the returned list contains all known
parameters or an error results. Otherwise, the returned list may
contain only those parameters that are accessible through this
session.
In active mode, parameters are returned that are currently active. In
any status mode, active and inactive parameters are returned. Parameters
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.