org.osid.configuration.rules

Interface ParameterProcessorEnablerRuleLookupSession

All Superinterfaces:

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

public interface ParameterProcessorEnablerRuleLookupSession
extends OsidSession

This session provides methods to retrieve ParameterProcessorEnabler to ParameterProcessor mappings. A ParameterProcessor with multiple ParameterProcessorEnablers means any positive rule evaluation across the enablers result in an effective ParameterProcessor.

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
• isolated configuration view: All methods in this session operate, retrieve and pertain parameter processor enablers defined explicitly in the current configuration
• federated configuration view: All methods in this session operate, retrieve and pertain to all parameter processor enablers defined in this configuration and any other parameter processor enablers implicitly available in this configuration through configuration inheritence.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupParameterProcessorEnablerRules() Tests if this user can perform lookups of parameter processor enabler/parameter processor mappings.
Configuration	getConfiguration() Gets the Configuration associated with this session.
Id	getConfigurationId() Gets the Configuration Id associated with this session.
IdList	getParameterProcessorEnablerIdsForParameterProcessor(Id parameterProcessorId) Gets the ParameterProcessorEnabler Id associated with a ParameterProcessor.
ParameterProcessorEnablerList	getParameterProcessorEnablersForParameterProcessor(Id parameterProcessorId) Gets the ParameterProcessorEnabler associated with a ParameterProcessor.
IdList	getParameterProcessorIdsForParameterProcessorEnabler(Id parameterProcessorEnablerId) Gets the ParameterProcessor Ids mapped to a ParameterProcessorEnabler.
ParameterProcessorList	getParameterProcessorsForParameterProcessorEnabler(Id parameterProcessorEnablerId) Gets the ParameterProcessors mapped to a ParameterProcessorEnabler.
void	useComparativeParameterProcessorEnablerRuleView() 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	usePlenaryParameterProcessorEnablerRuleView() A complete view of the ParameterProcessorEnabler and ParameterProcessor 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

getConfigurationId

Id getConfigurationId()

Gets the Configuration Id associated with this session.

Returns:

the Configuration Id associated with this session

Compliance:

mandatory - This method must be implemented.

getConfiguration

Configuration getConfiguration()
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets the Configuration associated with this session.

Returns:

the configuration

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupParameterProcessorEnablerRules

boolean canLookupParameterProcessorEnablerRules()

Tests if this user can perform lookups of parameter processor enabler/parameter processor 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.

useComparativeParameterProcessorEnablerRuleView

void useComparativeParameterProcessorEnablerRuleView()

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.

usePlenaryParameterProcessorEnablerRuleView

void usePlenaryParameterProcessorEnablerRuleView()

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

useFederatedConfigurationView

void useFederatedConfigurationView()

Federates the view for methods in this session. A federated view will include parameter processor enablers in configurations which are children of this configuration in the configuration hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedConfigurationView

void useIsolatedConfigurationView()

Isolates the view for methods in this session. An isolated view restricts lookups to this configuration only.

Compliance:

mandatory - This method is must be implemented.

getParameterProcessorEnablerIdsForParameterProcessor

IdList getParameterProcessorEnablerIdsForParameterProcessor(Id parameterProcessorId)
                                                            throws NotFoundException,
                                                                   OperationFailedException,
                                                                   PermissionDeniedException

Gets the ParameterProcessorEnabler Id associated with a ParameterProcessor.

Parameters:

parameterProcessorId - Id of the ParameterProcessor

Returns:

the parameter processor enabler Ids

Throws:

NotFoundException - parameterProcessorId is not found

NullArgumentException - parameterProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParameterProcessorEnablersForParameterProcessor

ParameterProcessorEnablerList getParameterProcessorEnablersForParameterProcessor(Id parameterProcessorId)
                                                                                 throws NotFoundException,
                                                                                        OperationFailedException,
                                                                                        PermissionDeniedException

Gets the ParameterProcessorEnabler associated with a ParameterProcessor.

Parameters:

parameterProcessorId - Id of the ParameterProcessor

Returns:

the parameter processor enablers

Throws:

NotFoundException - parameterProcessorId is not found

NullArgumentException - parameterProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParameterProcessorIdsForParameterProcessorEnabler

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

Gets the ParameterProcessor Ids mapped to a ParameterProcessorEnabler.

Parameters:

parameterProcessorEnablerId - Id of a ParameterProcessorEnabler

Returns:

list of parameter processor Ids

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.

getParameterProcessorsForParameterProcessorEnabler

ParameterProcessorList getParameterProcessorsForParameterProcessorEnabler(Id parameterProcessorEnablerId)
                                                                          throws NotFoundException,
                                                                                 OperationFailedException,
                                                                                 PermissionDeniedException

Gets the ParameterProcessors mapped to a ParameterProcessorEnabler.

Parameters:

parameterProcessorEnablerId - Id of a ParameterProcessorEnabler

Returns:

list of parameter processors

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.