Interface VoteQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
VoteSearchSession
public interface VoteQuerySession extends OsidSession

This session provides methods for searching Vote objects. The search query is constructed using the VoteQuery. The vote record Type also specifies the record for the vote query.

This session defines views that offer differing behaviors for searching.

  • federated polls view: searches include votes in polls of which these polls is an ancestor in the polls hierarchy
  • isolated polls view: searches are restricted to votes in these polls only

Votes may have a query record indicated by their respective record types. The query record is accessed via the VoteQuery.

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

    • canSearchVotes

      boolean canSearchVotes()
      Tests if this user can perform Vote 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 votes 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 searches to this polls only.
      Compliance:
      mandatory - This method is must be implemented.

    • getVoteQuery

      VoteQuery getVoteQuery()
      Gets a vote query.
      Returns:
      the vote query
      Compliance:
      mandatory - This method must be implemented.

    • getVotesByQuery

      VoteList getVotesByQuery(VoteQuery voteQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Vote matching the given vote query.
      Parameters:
      voteQuery - the vote query
      Returns:
      the returned VoteList
      Throws:
      NullArgumentException - voteQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - voteQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.