Interface AgendaSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface AgendaSession extends OsidSession

This session provides methods to process Agendas .

Agendas are OsidRules that may require additional input in the form of an AgendaCondition to be evaluated.

An AgendaCondition is acquired using getAgendaCondition() . The AgendaConditionRecords in the AgendaCondition must be supplied for a successful evaluation. Knowledge of a specific agenda Id is also an agreement to the understanding of the required AgendaConditionRecords as well as what is expected as a result. These record Types may be inspected in the AgendaConditionRecord and CheckResultRecord respectively.

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

    • canEvaluateAgendas

      boolean canEvaluateAgendas()
      Tests if this user can evaluate agendas. 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 evaluation is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAgendaCondition

      AgendaCondition getAgendaCondition(Id agendaId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets an AgendaCondition for the given Agenda . The record Types in the AgendaCondition are required for a successful evaluation.
      Parameters:
      agendaId - the Id of an Agenda
      Returns:
      an agenda 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.

    • evaluateAgendaOnCondition

      boolean evaluateAgendaOnCondition(Id agendaId, Condition agendaCondition) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Evaluates an agenda based on an input condition. The status of each Check evaluation is returned in a CheckResult .
      Parameters:
      agendaId - the Id of an Agenda
      agendaCondition - an agenda condition
      Returns:
      true if the evaluation is successful, false if not successful
      Throws:
      NotFoundException - agendaId is not found
      NullArgumentException - agendaId or agendaCondition is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - agendaCondition did not otiginate from getAgendaCondition() or is missing information required to evaluate agendaId
      Compliance:
      mandatory - This method must be implemented.