Interface VoteEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
VoteEnablerSearchSession
public interface VoteEnablerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

  • federated polls view: searches include vote enablers in polls of which this polls is an ancestor in the polls hierarchy
  • isolated polls view: searches are restricted to vote enablers in this polls

Vote enablers may have a query record indicated by their respective record types. The query record is accessed via the VoteEnablerQuery .

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

    • canSearchVoteEnablers

      boolean canSearchVoteEnablers()
      Tests if this user can perform VoteEnabler 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 not offer lookup 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 vote enablers 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.

    • getVoteEnablerQuery

      VoteEnablerQuery getVoteEnablerQuery()
      Gets a vote enabler query.
      Returns:
      the vote enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getVoteEnablersByQuery

      VoteEnablerList getVoteEnablersByQuery(VoteEnablerQuery voteEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of VoteEnablers matching the given search.
      Parameters:
      voteEnablerQuery - the vote enabler query
      Returns:
      the returned VoteEnablerList
      Throws:
      NullArgumentException - voteEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - voteEnablerQuery did not originate from getVoteEnablerQuery()
      Compliance:
      mandatory - This method must be implemented.