org.osid.configuration

Interface ConfigurationLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

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.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition

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.

Method Summary

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canLookupConfigurations

boolean canLookupConfigurations()

Tests if this user can perform 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.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeConfigurationView

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. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryConfigurationView

void usePlenaryConfigurationView()

A complete view of the 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.

Compliance:

mandatory - This method is must be implemented.

getConfiguration

Configuration getConfiguration(Id configurationId)
                               throws NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

Gets the 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.

Parameters:

configurationId - the Id of the Configuration to retrieve

Returns:

the Configuration

Throws:

NotFoundException - no Configuration found with the given Id

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConfigurationsByIds

ConfigurationList getConfigurationsByIds(IdList configurationIds)
                                         throws NotFoundException,
                                                OperationFailedException,
                                                PermissionDeniedException

Gets a 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.

Parameters:

configurationIds - the list of Ids to retrieve

Returns:

the returned Configuration list

Throws:

NotFoundException - an Id was not found

NullArgumentException - configurationIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConfigurationsByGenusType

ConfigurationList getConfigurationsByGenusType(Type configurationGenusType)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Gets an 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.

Parameters:

configurationGenusType - a configuration genus type

Returns:

the returned Configuration list

Throws:

NullArgumentException - configurationGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConfigurationsByParentGenusType

ConfigurationList getConfigurationsByParentGenusType(Type configurationGenusType)
                                                     throws OperationFailedException,
                                                            PermissionDeniedException

Gets an 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.

Parameters:

configurationGenusType - a configuration genus type

Returns:

the returned Configuration list

Throws:

NullArgumentException - configurationGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConfigurationsByRecordType

ConfigurationList getConfigurationsByRecordType(Type configurationRecordType)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Gets a 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.

Parameters:

configurationRecordType - a configuration record type

Returns:

the returned Configuration list

Throws:

NullArgumentException - configurationRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConfigurationsByProvider

ConfigurationList getConfigurationsByProvider(Id resourceId)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Gets a 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.

Parameters:

resourceId - a resource Id

Returns:

the returned Configuration list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConfigurations

ConfigurationList getConfigurations()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets all 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.

Returns:

a list of Configurations

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.