Interface ParameterConfigurationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ParameterConfigurationSession
extends OsidSession

This session defines methods for accessing the configurations of a parameter. A Parameter may appear in multiple Configurations . Each Configuration may have its own authorizations governing who is allowed to look at it.

This lookup session defines two views:

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

Method Summary

Modifier and Type	Method	Description
boolean	canLookupParameterConfigurations()	Tests if this user can perform lookups on configurations of parameters.
IdList	getConfigurationIdsByParameter(Id parameterId)	Gets the Configuration Ids mapped to a Parameter .
ConfigurationList	getConfigurationsByParameter(Id parameterId)	Gets the Configurations mapped to a Parameter .
IdList	getParameterIdsByConfiguration(Id configurationId)	Gets the list of Parameter Ids associated with a Configuration .
IdList	getParameterIdsByConfigurations(IdList configurationIds)	Gets the list of Parameter Ids associated with a list of Configurations .
ParameterList	getParametersByConfiguration(Id configurationId)	Gets the list of Parameters associated with a Configuration .
ParameterList	getParametersByConfigurations(IdList configurationIds)	Gets the list of Parameters associated with a list of Configurations .
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	usePlenaryParameterView()	A complete view of the Parameter returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canLookupParameterConfigurations

boolean canLookupParameterConfigurations()

Tests if this user can perform lookups on configurations of parameters. 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.

Returns:

false if lookups are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeParameterView

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

Compliance:

mandatory - This method is must be implemented.

usePlenaryParameterView

void usePlenaryParameterView()

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

Compliance:

mandatory - This method is must be implemented.

getParameterIdsByConfiguration

IdList getParameterIdsByConfiguration(Id configurationId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Parameter Ids associated with a Configuration .

Parameters:

configurationId - Id of the Configuration

Returns:

list of matching parameter Ids

Throws:

NotFoundException - configurationId is not found

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParametersByConfiguration

ParameterList getParametersByConfiguration(Id configurationId)
                                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Parameters associated with a Configuration .

Parameters:

configurationId - Id of the Configuration

Returns:

list of matching parameters

Throws:

NotFoundException - configurationId is not found

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParameterIdsByConfigurations

IdList getParameterIdsByConfigurations(IdList configurationIds)
                                throws OperationFailedException,
PermissionDeniedException

Gets the list of Parameter Ids associated with a list of Configurations .

Parameters:

configurationIds - list of configurations

Returns:

list of parameter Ids

Throws:

NullArgumentException - configurationIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParametersByConfigurations

ParameterList getParametersByConfigurations(IdList configurationIds)
                                     throws OperationFailedException,
PermissionDeniedException

Gets the list of Parameters associated with a list of Configurations .

Parameters:

configurationIds - list of configurations

Returns:

list of parameters

Throws:

NullArgumentException - configurationIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConfigurationIdsByParameter

IdList getConfigurationIdsByParameter(Id parameterId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Configuration Ids mapped to a Parameter .

Parameters:

parameterId - Id of a Parameter

Returns:

list of configuration Ids

Throws:

NotFoundException - parameterId is not found

NullArgumentException - parameterId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConfigurationsByParameter

ConfigurationList getConfigurationsByParameter(Id parameterId)
                                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Configurations mapped to a Parameter .

Parameters:

parameterId - Id of a Parameter

Returns:

list of configurations

Throws:

NotFoundException - parameterId is not found

NullArgumentException - parameterId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.