org.osid.rules.check

Interface EvaluationSession

All Superinterfaces:

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

public interface EvaluationSession
extends OsidSession

This is the session for evaluating agendas.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canEvaluate() Tests if this user can perform evaluations.
CheckResultList	evaluateAgenda(Id agendaId, Id resourceId, java.util.Date now, Condition condition) Evaluates an agenda.
Condition	getCondition(Id agendaId) Gets the Condition to supply data to the evaluation.
Engine	getEngine() Gets the Engine associated with this session.
Id	getEngineId() Gets the Engine Id associated with this session.

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

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.

canEvaluate

boolean canEvaluate()

Tests if this user can perform evaluations. 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 agenda methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getCondition

Condition getCondition(Id agendaId)
                       throws NotFoundException,
                              OperationFailedException,
                              PermissionDeniedException

Gets the Condition to supply data to the evaluation. The condition supplies all the records aligning with the inputs of the Check rules.

Parameters:

agendaId - the Id of a Agenda

Returns:

a 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.

evaluateAgenda

CheckResultList evaluateAgenda(Id agendaId,
                             Id resourceId,
                             java.util.Date now,
                             Condition condition)
                               throws NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

Evaluates an agenda.

Parameters:

agendaId - the Id of an Agenda

resourceId - the Id of a Resource to be applied to a Demographic

now - the date to apply

condition - a condition

Returns:

a list of results or empty if successful

Throws:

NotFoundException - agendaId is not found

NullArgumentException - agendaId, resourceId, now , or condition is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure making request

UnsupportedException - condition is not of this service

Compliance:

mandatory - This method must be implemented.