Interface CandidateQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
CandidateSearchSession
public interface CandidateQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

Candidates may have a candidate query record indicated by their respective record types. The candidate query record is accessed via the CandidateQuery .

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

    • canSearchCandidates

      boolean canSearchCandidates()
      Tests if this user can perform Candidate 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 candidates 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.

    • getCandidateQuery

      CandidateQuery getCandidateQuery()
      Gets a candidate query. The returned query will not have an extension query.
      Returns:
      the candidate query
      Compliance:
      mandatory - This method must be implemented.

    • getCandidatesByQuery

      CandidateList getCandidatesByQuery(CandidateQuery candidateQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Candidates matching the given candidate query.
      Parameters:
      candidateQuery - the candidate query
      Returns:
      the returned CandidateList
      Throws:
      NullArgumentException - candidateQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - candidateQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.