public interface EvaluationSession extends OsidSession
This is the session for evaluating agendas.
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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getEngineId()
Engine
Id
associated with this
session. Engine Id
associated with this sessionmandatory
- This method must be implemented. Engine getEngine() throws OperationFailedException, PermissionDeniedException
Engine
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canEvaluate()
PERMISSION_DENIED.
This is intended as a hint to an
application that may not offer lookup operations to unauthorized
users. false
if agenda methods are not authorized,
true
otherwisemandatory
- This method must be implemented. Condition getCondition(Id agendaId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Condition
to supply data to the evaluation.
The condition supplies all the records aligning with the inputs of the
Check
rules.agendaId
- the Id
of a Agenda
NotFoundException
- agendaId
is not
foundNullArgumentException
- agendaId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
making requestmandatory
- This method must be implemented. CheckResultList evaluateAgenda(Id agendaId, Id resourceId, java.util.Date now, Condition condition) throws NotFoundException, OperationFailedException, PermissionDeniedException
agendaId
- the Id
of an Agenda
resourceId
- the Id
of a Resource
to be applied to a Demographic
now
- the date to applycondition
- a conditionNotFoundException
- agendaId
is not
foundNullArgumentException
- agendaId, resourceId,
now
, or condition
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
making requestUnsupportedException
- condition
is not
of this servicemandatory
- This method must be implemented.