Interface InstructionApplicabilitySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface InstructionApplicabilitySession
extends OsidSession

This session provides methods to evaluate Instructions . Instructions are OsidRuleApplicators which compose Agendas .

Instructions are also OsidRuleApplicators for the related Checks . OsidRuleApplicators have built-in rules to vary by time, time period, and by a demographic Resource . One or more of these dimenions may be required. Where they are not required, providing these dimensions may or may not have any effect on the evaluation. For example, an Instruction that varies with a specific demographic may be given an anonymous resource with which to evaluate. Similarly, not supplying a time period may only match an Instruction with no time period that relates to a Check that fails.

An InstructionCondition is acquired using getInstructionCondition() . The InstructionConditionRecords in the InstructionCondition must be supplied for a successful evaluation. Knowledge of a specific agenda Id is also an agreement to the understanding of the required InstructionConditionRecords . These record Types may be inspected in the InstructionConditionRecord .

Method Summary

Modifier and Type	Method	Description
boolean	canEvaluateInstructions()	Tests if this user can evaluate instructions.
InstructionList	getApplicableInstructions(Id agendaId, InstructionCondition instructionCondition)	Gets a list of applicable Instructions for an Agenda .
Engine	getEngine()	Gets the Engine associated with this session.
Id	getEngineId()	Gets the Engine Id associated with this session.
InstructionCondition	getInstructionCondition(Id agendaId)	Gets an InstructionCondition for the given Agenda .

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

getEngineId

Id getEngineId()

Gets the Engine Id associated with this session.

Returns:

the Engine Id associated with this session

Compliance:

mandatory - This method must be implemented.

getEngine

Engine getEngine()
          throws OperationFailedException,
PermissionDeniedException

Gets the Engine associated with this session.

Returns:

the engine

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canEvaluateInstructions

boolean canEvaluateInstructions()

Tests if this user can evaluate instructions. 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 not offer lookup operations to unauthorized users.

Returns:

false if instruction evaluation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getInstructionCondition

InstructionCondition getInstructionCondition(Id agendaId)
                                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets an InstructionCondition for the given Agenda . The record Types in the InstructionCondition are required for a successful evaluation.

Parameters:

agendaId - the Id of an Agenda

Returns:

an instruction condition

Throws:

NotFoundException - agendaId is not found

NullArgumentException - agendaId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure making request

Compliance:

mandatory - This method must be implemented.

getApplicableInstructions

InstructionList getApplicableInstructions(Id agendaId,
 InstructionCondition instructionCondition)
                                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of applicable Instructions for an Agenda .

Parameters:

agendaId - the Id of an Agenda

instructionCondition - an instruction condition

Returns:

a list of applicable instructions

Throws:

NotFoundException - instructionId is not found

NullArgumentException - instructionId or instructionCondition is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - instructionCondition did not originate from getInstructionCondition()

Compliance:

mandatory - This method must be implemented.