public interface ConfigurationLookupSession extends OsidSession
This session provides methods for retrieving Configuration
objects. The Configuration
represents a collection
of parameter values.
This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most applications
as it permits operation even if there is data that cannot be accessed. For
example, a browsing application may only need to examine the
Configurations
it can access, without breaking execution. However,
an assessment may only be useful if all Configurations
referenced by it are available, and a test-taking applicationmay sacrifice
some interoperability for the sake of precision.
Configurations may have an additional interface indicated by their
respective types. The interface extension is accessed via the
Configuration.
The returns may not be cast directly from the
returns in the lookup methods.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupConfigurations()
Tests if this user can perform
Configuration lookups. |
Configuration |
getConfiguration(Id configurationId)
Gets the
Configuration specified by its Id. |
ConfigurationList |
getConfigurations()
Gets all
Configurations, In plenary mode, the returned
list contains all known configurations or an error results. |
ConfigurationList |
getConfigurationsByGenusType(Type configurationGenusType)
Gets an
ConfigurationList corresponding to the given
configuration genus Type which does not include
configuration types derived from the specified Type. |
ConfigurationList |
getConfigurationsByIds(IdList configurationIds)
Gets a
ConfigurationList corresponding to the given
IdList. |
ConfigurationList |
getConfigurationsByParentGenusType(Type configurationGenusType)
Gets an
ConfigurationList corresponding to the given
configuration genus Type and include any additional
configurations with genus types derived from the specified
Type. |
ConfigurationList |
getConfigurationsByProvider(Id resourceId)
Gets a
ConfigurationList from the given provider
. |
ConfigurationList |
getConfigurationsByRecordType(Type configurationRecordType)
Gets a
ConfigurationList containing the given
configuration record Type. |
void |
useComparativeConfigurationView()
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 |
usePlenaryConfigurationView()
A complete view of the
Configuration returns is
desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupConfigurations()
Configuration
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 useComparativeConfigurationView()
mandatory
- This method is must be implemented. void usePlenaryConfigurationView()
Configuration
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. Configuration getConfiguration(Id configurationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Configuration
specified by its Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned
Configuration
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a Configuration
and retained for
compatibility.configurationId
- the Id
of the
Configuration
to retrieve Configuration
NotFoundException
- no Configuration
found with the given Id
NullArgumentException
- configurationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConfigurationList getConfigurationsByIds(IdList configurationIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ConfigurationList
corresponding to the given
IdList.
In plenary mode, the returned list contains all
of the configurations 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 Configurations
may be omitted
from the list and may present the elements in any order including
returning a unique set.configurationIds
- the list of Ids
to retrieve Configuration
listNotFoundException
- an Id was
not foundNullArgumentException
- configurationIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConfigurationList getConfigurationsByGenusType(Type configurationGenusType) throws OperationFailedException, PermissionDeniedException
ConfigurationList
corresponding to the given
configuration genus Type
which does not include
configuration types derived from the specified Type.
In
plenary mode, the returned list contains all known configurations or
an error results. Otherwise, the returned list may contain only those
configurations that are accessible through this session.configurationGenusType
- a configuration genus type Configuration
listNullArgumentException
- configurationGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConfigurationList getConfigurationsByParentGenusType(Type configurationGenusType) throws OperationFailedException, PermissionDeniedException
ConfigurationList
corresponding to the given
configuration genus Type
and include any additional
configurations with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
configurations or an error results. Otherwise, the returned list may
contain only those configurations that are accessible through this
session.configurationGenusType
- a configuration genus type Configuration
listNullArgumentException
- configurationGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConfigurationList getConfigurationsByRecordType(Type configurationRecordType) throws OperationFailedException, PermissionDeniedException
ConfigurationList
containing the given
configuration record Type.
In plenary mode, the
returned list contains all known configurations or an error results.
Otherwise, the returned list may contain only those configurations
that are accessible through this session.configurationRecordType
- a configuration record type Configuration
listNullArgumentException
- configurationRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConfigurationList getConfigurationsByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
ConfigurationList
from the given provider
.
In plenary mode, the returned list contains all known
configurations or an error results. Otherwise, the returned list may
contain only those configurations that are accessible through this
session.resourceId
- a resource Id
Configuration
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConfigurationList getConfigurations() throws OperationFailedException, PermissionDeniedException
Configurations,
In plenary mode, the returned
list contains all known configurations or an error results. Otherwise,
the returned list may contain only those configurations that are
accessible through this session. Configurations
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.