Interface RuleEngineSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface RuleEngineSession
extends OsidSession

This session provides methods to retrieve Rule to Engine mappings. A Rule may appear in multiple Engines . Each engine 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

Modifier and Type	Method	Description
boolean	canLookupRuleEngineMappings()	Tests if this user can perform lookups of rule/engine mappings.
IdList	getEngineIdsByRule(Id ruleId)	Gets the Engine Ids mapped to a Rule .
EngineList	getEnginesByRule(Id ruleId)	Gets the Engine objects mapped to a Rule .
IdList	getRuleIdsByEngine(Id engineId)	Gets the list of Rule Ids associated with an Engine .
IdList	getRuleIdsByEngines(IdList engineIds)	Gets the list of Rule Ids corresponding to a list of Engine objects.
RuleList	getRulesByEngine(Id engineId)	Gets the list of Rules associated with an Engine .
RuleList	getRulesByEngines(IdList engineIds)	Gets the list of Rules corresponding to a list of Engine objects.
void	useComparativeRuleView()	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	usePlenaryRuleView()	A complete view of the Rule 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

canLookupRuleEngineMappings

boolean canLookupRuleEngineMappings()

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

useComparativeRuleView

void useComparativeRuleView()

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.

usePlenaryRuleView

void usePlenaryRuleView()

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

getRuleIdsByEngine

IdList getRuleIdsByEngine(Id engineId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Rule Ids associated with an Engine .

Parameters:

engineId - Id of the Engine

Returns:

list of related rule Ids

Throws:

NotFoundException - engineId is not found

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRulesByEngine

RuleList getRulesByEngine(Id engineId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Rules associated with an Engine .

Parameters:

engineId - Id of the Engine

Returns:

list of related rules

Throws:

NotFoundException - engineId is not found

NullArgumentException - engineId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRuleIdsByEngines

IdList getRuleIdsByEngines(IdList engineIds)
                    throws OperationFailedException,
PermissionDeniedException

Gets the list of Rule Ids corresponding to a list of Engine objects.

Parameters:

engineIds - list of engine Ids

Returns:

list of rule Ids

Throws:

NullArgumentException - engineIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRulesByEngines

RuleList getRulesByEngines(IdList engineIds)
                    throws OperationFailedException,
PermissionDeniedException

Gets the list of Rules corresponding to a list of Engine objects.

Parameters:

engineIds - list of engine Ids

Returns:

list of rules

Throws:

NullArgumentException - engineIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEngineIdsByRule

IdList getEngineIdsByRule(Id ruleId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Engine Ids mapped to a Rule .

Parameters:

ruleId - Id of a Rule

Returns:

list of engines

Throws:

NotFoundException - ruleId is not found

NullArgumentException - ruleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEnginesByRule

EngineList getEnginesByRule(Id ruleId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Engine objects mapped to a Rule .

Parameters:

ruleId - Id of a Rule

Returns:

list of engines

Throws:

NotFoundException - ruleId is not found

NullArgumentException - ruleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.