Interface VoteSmartPollsSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A VoteQuery can be retrieved from this session and mapped to this Polls to create a virtual collection of Votes . The votes may be sequenced using the VoteSearchOrder from this session.

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

    • getVoteQuery

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

    • getVoteSearchOrder

      VoteSearchOrder getVoteSearchOrder()
      Gets a vote search order.
      Returns:
      the vote search order
      Compliance:
      mandatory - This method must be implemented.

    • applyVoteQuery

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

    • inspectVoteQuery

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

    • applyVoteSequencing

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

    • getVoteQueryFromInspector

      VoteQuery getVoteQueryFromInspector(VoteQueryInspector voteQueryInspector)
      Gets a vote query from an inspector.
      Parameters:
      voteQueryInspector - a vote query inspector
      Returns:
      the vote query
      Throws:
      NullArgumentException - voteQueryInspector is null
      UnsupportedException - voteQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.