Interface CandidateSmartPollsSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A CandidateQuery can be retrieved from this session and mapped to this Polls to create a virtual collection of Candidates . The candidates may be sequenced using the CandidateSearchOrder from this session.

This Polls has a default query that matches any candidate and a default search order that specifies no sequencing. The queries may be examined using a CandidateQueryInspector . The query may be modified by converting the inspector back to a 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.

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

    • getCandidateQuery

      CandidateQuery getCandidateQuery()
      Gets a candidate query.
      Returns:
      the candidate query
      Compliance:
      mandatory - This method must be implemented.

    • getCandidateSearchOrder

      CandidateSearchOrder getCandidateSearchOrder()
      Gets a candidate search order.
      Returns:
      the candidate search order
      Compliance:
      mandatory - This method must be implemented.

    • applyCandidateQuery

      void applyCandidateQuery(CandidateQuery candidateQuery) throws OperationFailedException, PermissionDeniedException
      Applies a candidate query to this polls.
      Parameters:
      candidateQuery - the candidate query
      Throws:
      NullArgumentException - candidateQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - candidateQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectCandidateQuery

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

    • applyCandidateSequencing

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

    • getCandidateQueryFromInspector

      CandidateQuery getCandidateQueryFromInspector(CandidateQueryInspector candidateQueryInspector)
      Gets a candidate query from an inspector.
      Parameters:
      candidateQueryInspector - a candidate query inspector
      Returns:
      the candidate query
      Throws:
      NullArgumentException - candidateQueryInspector is null
      UnsupportedException - candidateQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.