public interface ProcessingSession extends OsidSession
This is a session for checking agendas.
Modifier and Type | Method and Description |
---|---|
boolean |
canAccessAgendas()
Tests if this user can perform
Agenda checks. |
Engine |
getEngine()
Gets the
Engine associated with this session. |
Id |
getEngineId()
Gets the
Engine Id associated with this
session. |
InstructionList |
getInstructionsForProcessing(Id agendaId,
Id resourceId,
java.util.Date now)
Gets al ist of instructions for processing.
|
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 canAccessAgendas()
Agenda
checks. 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. false
if agenda methods are not authorized,
true
otherwisemandatory
- This method must be implemented. InstructionList getInstructionsForProcessing(Id agendaId, Id resourceId, java.util.Date now) throws NotFoundException, OperationFailedException, PermissionDeniedException
Instructions
based on the
demographic and time criteria in the instruction but performs no
evaluation on the Checks.
An empty list is a successful
evaluation.agendaId
- the Id
of an Agenda
resourceId
- the Id
of a Resource
to be applied to a Demographic
now
- the date to applyNotFoundException
- agendaId
is not
foundNullArgumentException
- agendaId, resourceId,
or now
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
making requestmandatory
- This method must be implemented.