org.osid.configuration.rules

Interface ValueEnablerRuleLookupSession

All Superinterfaces:

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

public interface ValueEnablerRuleLookupSession
extends OsidSession

This session provides methods to retrieve ValueEnabler to Value mappings. A Value with multiple ValueEnablers means any positive rule evaluation across the enablers result in a visible Value.

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupValueEnablerRules() Tests if this user can perform lookups of value enabler/value mappings.
Configuration	getConfiguration() Gets the Configuration associated with this session.
Id	getConfigurationId() Gets the Configuration Id associated with this session.
IdList	getValueEnablerIdsForValue(Id valueId) Gets the ValueEnabler Id associated with a Value.
ValueEnablerList	getValueEnablersForValue(Id valueId) Gets the ValueEnablers associated with a Value.
IdList	getValueIdsForValueEnabler(Id valueEnablerId) Gets the Value Ids mapped to a ValueEnabler.
ValueList	getValuesForValueEnabler(Id valueEnablerId) Gets the Values mapped to a ValueEnabler.
void	useComparativeValueEnablerRuleView() 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	usePlenaryValueEnablerRuleView() A complete view of the ValueEnabler and Value 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.

canLookupValueEnablerRules

boolean canLookupValueEnablerRules()

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

useComparativeValueEnablerRuleView

void useComparativeValueEnablerRuleView()

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.

usePlenaryValueEnablerRuleView

void usePlenaryValueEnablerRuleView()

A complete view of the ValueEnabler and Value 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 value 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.

getValueEnablerIdsForValue

IdList getValueEnablerIdsForValue(Id valueId)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Gets the ValueEnabler Id associated with a Value.

Parameters:

valueId - Id of the Value

Returns:

the value enabler Ids

Throws:

NotFoundException - valueId is not found

NullArgumentException - valueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getValueEnablersForValue

ValueEnablerList getValueEnablersForValue(Id valueId)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Gets the ValueEnablers associated with a Value.

Parameters:

valueId - Id of the Value

Returns:

the value enablers

Throws:

NotFoundException - valueId is not found

NullArgumentException - valueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getValueIdsForValueEnabler

IdList getValueIdsForValueEnabler(Id valueEnablerId)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Gets the Value Ids mapped to a ValueEnabler.

Parameters:

valueEnablerId - Id of a ValueEnabler

Returns:

list of value Ids

Throws:

NotFoundException - valueEnablerId is not found

NullArgumentException - valueEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getValuesForValueEnabler

ValueList getValuesForValueEnabler(Id valueEnablerId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Gets the Values mapped to a ValueEnabler.

Parameters:

valueEnablerId - Id of a ValueEnabler

Returns:

list of values

Throws:

NotFoundException - valueEnablerId is not found

NullArgumentException - valueEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.