Interface VoteEnablerSmartPollsSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A VoteEnablerQuery can be retrieved from this session and mapped to this Polls to create a virtual collection of VoteEnablers . The vote enablers may be sequenced using the VoteEnablerSearchOrder from this session.

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

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

    • getVoteEnablerQuery

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

    • getVoteEnablerSearchOrder

      VoteEnablerSearchOrder getVoteEnablerSearchOrder()
      Gets a vote enabler search order.
      Returns:
      the vote enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • applyVoteEnablerQuery

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

    • inspectVoteEnablerQuery

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

    • applyVoteEnablerSequencing

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

    • getVoteEnablerQueryFromInspector

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