org.osid.configuration.rules

Interface ParameterProcessorEnablerConfigurationSession

All Superinterfaces:

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

public interface ParameterProcessorEnablerConfigurationSession
extends OsidSession

This session provides methods to retrieve ParameterProcessorEnabler to Configuration mappings. A ParameterProcessorEnabler may appear in multiple Configuration objects. Each configuration may have its own authorizations governing who is allowed to look at it.

This lookup session defines several 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

Methods

Modifier and Type	Method and Description
boolean	canLookupParameterProcessorEnablerConfigurationMappings() Tests if this user can perform lookups of parameter processor enabler/configuration mappings.
IdList	getConfigurationIdsByParameterProcessorEnabler(Id parameterProcessorEnablerId) Gets the Configuration Ids mapped to a ParameterProcessorEnabler.
ConfigurationList	getConfigurationsByParameterProcessorEnabler(Id parameterProcessorEnablerId) Gets the Configurations mapped to a ParameterProcessorEnabler.
IdList	getParameterProcessorEnablerIdsByConfiguration(Id configurationId) Gets the list of ParameterProcessorEnablerIds associated with an Configuration.
IdList	getParameterProcessorEnablerIdsByConfigurations(IdList configurationIds) Gets the list of ParameterProcessorEnabler Ids corresponding to a list of Configurations.
ParameterProcessorEnablerList	getParameterProcessorEnablersByConfiguration(Id configurationId) Gets the list of parameter processor enablers associated with an Configuration.
ParameterProcessorEnablerList	getParameterProcessorEnablersByConfigurations(IdList configurationIds) Gets the list of parameter processor enablers corresponding to a list of Configurations.
void	useComparativeParameterProcessorEnablerConfigurationView() 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	usePlenaryParameterProcessorEnablerConfigurationView() A complete view of the ParameterProcessorEnabler and 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

canLookupParameterProcessorEnablerConfigurationMappings

boolean canLookupParameterProcessorEnablerConfigurationMappings()

Tests if this user can perform lookups of parameter processor enabler/configuration mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeParameterProcessorEnablerConfigurationView

void useComparativeParameterProcessorEnablerConfigurationView()

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.

usePlenaryParameterProcessorEnablerConfigurationView

void usePlenaryParameterProcessorEnablerConfigurationView()

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

getParameterProcessorEnablerIdsByConfiguration

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

Gets the list of ParameterProcessorEnablerIds associated with an Configuration.

Parameters:

configurationId - Id of the Configuration

Returns:

list of related parameter processor enabler 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.

getParameterProcessorEnablersByConfiguration

ParameterProcessorEnablerList getParameterProcessorEnablersByConfiguration(Id configurationId)
                                                                           throws NotFoundException,
                                                                                  OperationFailedException,
                                                                                  PermissionDeniedException

Gets the list of parameter processor enablers associated with an Configuration.

Parameters:

configurationId - Id of the Configuration

Returns:

list of related parameter processor enablers

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.

getParameterProcessorEnablerIdsByConfigurations

IdList getParameterProcessorEnablerIdsByConfigurations(IdList configurationIds)
                                                       throws OperationFailedException,
                                                              PermissionDeniedException

Gets the list of ParameterProcessorEnabler Ids corresponding to a list of Configurations.

Parameters:

configurationIds - list of configuration Ids

Returns:

list of parameter processor enabler Ids

Throws:

NullArgumentException - configurationIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParameterProcessorEnablersByConfigurations

ParameterProcessorEnablerList getParameterProcessorEnablersByConfigurations(IdList configurationIds)
                                                                            throws OperationFailedException,
                                                                                   PermissionDeniedException

Gets the list of parameter processor enablers corresponding to a list of Configurations.

Parameters:

configurationIds - list of configuration Ids

Returns:

list of parameter processor enablers

Throws:

NullArgumentException - configurationIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConfigurationIdsByParameterProcessorEnabler

IdList getConfigurationIdsByParameterProcessorEnabler(Id parameterProcessorEnablerId)
                                                      throws NotFoundException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

Gets the Configuration Ids mapped to a ParameterProcessorEnabler.

Parameters:

parameterProcessorEnablerId - Id of a ParameterProcessorEnabler

Returns:

list of configurations

Throws:

NotFoundException - parameterProcessorEnablerId is not found

NullArgumentException - parameterProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConfigurationsByParameterProcessorEnabler

ConfigurationList getConfigurationsByParameterProcessorEnabler(Id parameterProcessorEnablerId)
                                                               throws NotFoundException,
                                                                      OperationFailedException,
                                                                      PermissionDeniedException

Gets the Configurations mapped to a ParameterProcessorEnabler.

Parameters:

parameterProcessorEnablerId - Id of a ParameterProcessorEnabler

Returns:

list of configurations

Throws:

NotFoundException - parameterProcessorEnablerId is not found

NullArgumentException - parameterProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.