Interface BallotConstrainerEnablerSmartPollsSession

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

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

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

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

    • getBallotConstrainerEnablerQuery

      BallotConstrainerEnablerQuery getBallotConstrainerEnablerQuery()
      Gets a ballot constrainer enabler query.
      Returns:
      the ballot constrainer enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getBallotConstrainerEnablerSearchOrder

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

    • applyBallotConstrainerEnablerQuery

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

    • inspectBallotConstrainerEnablerQuery

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

    • applyBallotConstrainerEnablerSequencing

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

    • getBallotConstrainerEnablerQueryFromInspector

      BallotConstrainerEnablerQuery getBallotConstrainerEnablerQueryFromInspector(BallotConstrainerEnablerQueryInspector ballotConstrainerEnablerQueryInspector)
      Gets a ballot constrainer enabler query from an inspector.
      Parameters:
      ballotConstrainerEnablerQueryInspector - a ballot constrainer enabler query inspector
      Returns:
      the ballot constrainer enabler query
      Throws:
      NullArgumentException - ballotConstrainerEnablerQueryInspector is null
      UnsupportedException - ballotConstrainerEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.