Interface BallotQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
BallotSearchSession
public interface BallotQuerySession extends OsidSession

This session provides methods for searching among Ballot objects. The search query is constructed using the BallotQuery.

This session defines views that offer differing behaviors for searching.

  • federated polls view: searches include ballots in polls of which this polls is a ancestor in the polls hierarchy
  • isolated polls view: searches are restricted to ballots in this polls

Ballots may have a ballot query record indicated by their respective record types. The ballot query record is accessed via the BallotQuery.

  • 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 associated with this session
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSearchBallots

      boolean canSearchBallots()
      Tests if this user can perform Ballot searches. 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 opt not to offer search operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedPollsView

      void useFederatedPollsView()
      Federates the view for methods in this session. A federated view will include ballots in polls which are children of this polls in the polls hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedPollsView

      void useIsolatedPollsView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this polls only.
      Compliance:
      mandatory - This method is must be implemented.

    • getBallotQuery

      BallotQuery getBallotQuery()
      Gets a ballot query.
      Returns:
      the ballot query
      Compliance:
      mandatory - This method must be implemented.

    • getBallotsByQuery

      BallotList getBallotsByQuery(BallotQuery ballotQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Ballots matching the given query.
      Parameters:
      ballotQuery - the ballot query
      Returns:
      the returned BallotList
      Throws:
      NullArgumentException - ballotQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - ballotQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.