Interface BallotConstrainerSmartPollsSession

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

This session manages queries and sequencing to create "smart" dynamic polls. A BallotConstrainerQuery can be retrieved from this session and mapped to this Polls to create a virtual collection of ballot constrainers. The ballot constrainer may be sequenced using the BallotConstrainerSearchOrder from this session.

This Polls has a default query that matches any ballot constrainer and a default search order that specifies no sequencing. The queries may be examined using a BallotConstrainerQueryInspector . The query may be modified by converting the inspector back to a BallotConstrainerQuery .

  • Method Details

    • getPollsId

      Id getPollsId()
      Gets the Polls Id associated with this session.
      Returns:
      the Polls Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getPolls

      Polls getPolls() throws OperationFailedException, PermissionDeniedException
      Gets the Polls associated with this session.
      Returns:
      the polls
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageSmartPolls

      boolean canManageSmartPolls()
      Tests if this user can manage smart polls. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
      Returns:
      false if smart polls management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getBallotConstrainerQuery

      BallotConstrainerQuery getBallotConstrainerQuery()
      Gets a ballot constrainer query.
      Returns:
      the ballot constrainer query
      Compliance:
      mandatory - This method must be implemented.

    • getBallotConstrainerSearchOrder

      BallotConstrainerSearchOrder getBallotConstrainerSearchOrder()
      Gets a ballot constrainer search order.
      Returns:
      the ballot constrainer search order
      Compliance:
      mandatory - This method must be implemented.

    • applyBallotConstrainerQuery

      void applyBallotConstrainerQuery(BallotConstrainerQuery ballotConstrainerQuery) throws OperationFailedException, PermissionDeniedException
      Applies a ballot constrainer query to this polls.
      Parameters:
      ballotConstrainerQuery - the ballot constrainer query
      Throws:
      NullArgumentException - ballotConstrainerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - ballotConstrainerQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectBallotConstrainerQuery

      BallotConstrainerQueryInspector inspectBallotConstrainerQuery() throws OperationFailedException, PermissionDeniedException
      Gets a ballot constrainer query inspector for this polls.
      Returns:
      the ballot constrainer query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyBallotConstrainerSequencing

      void applyBallotConstrainerSequencing(BallotConstrainerSearchOrder ballotConstrainerSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a ballot constrainer search order to this polls.
      Parameters:
      ballotConstrainerSearchOrder - the ballot constrainer search order
      Throws:
      NullArgumentException - ballotConstrainerSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - ballotConstrainerSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getBallotConstrainerQueryFromInspector

      BallotConstrainerQuery getBallotConstrainerQueryFromInspector(BallotConstrainerQueryInspector ballotConstrainerQueryInspector)
      Gets a ballot constrainer query from an inspector.
      Parameters:
      ballotConstrainerQueryInspector - a ballot constrainer query inspector
      Returns:
      the ballot constrainer query
      Throws:
      NullArgumentException - ballotConstrainerQueryInspector is null
      UnsupportedException - ballotConstrainerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.