org.osid.rules.check

Interface ProcessingSession

All Superinterfaces:

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

public interface ProcessingSession
extends OsidSession

This is a session for checking agendas.

Method Summary

Methods

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.

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.

canAccessAgendas

boolean canAccessAgendas()

Tests if this user can perform 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.

Returns:

false if agenda methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getInstructionsForProcessing

InstructionList getInstructionsForProcessing(Id agendaId,
                                           Id resourceId,
                                           java.util.Date now)
                                             throws NotFoundException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Gets al ist of instructions for processing. This method returns a filtered list of active 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.

Parameters:

agendaId - the Id of an Agenda

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

now - the date to apply

Returns:

a list of instructions

Throws:

NotFoundException - agendaId is not found

NullArgumentException - agendaId, resourceId, or now is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure making request

Compliance:

mandatory - This method must be implemented.