Interface VoteEnablerRuleLookupSession

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

This session provides methods to retrieve VoteEnabler to Vote mappings.

Th is lookup session defines several views:
  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated polls view: All methods in this session operate, retrieve and pertain to vote enablers defined explicitly in the current polls
  • federated polls view: All methods in this session operate, retrieve and pertain to all vote enablers defined in this polls and any other vote enablers implicitly available in this polls through polls inheritence.

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

    • canLookupVoteEnablerRules

      boolean canLookupVoteEnablerRules()
      Tests if this user can perform lookups of vote enabler/vote mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.
      Returns:
      false if looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeVoteEnablerRuleView

      void useComparativeVoteEnablerRuleView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryVoteEnablerRuleView

      void usePlenaryVoteEnablerRuleView()
      A complete view of the VoteEnabler and Vote returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is 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 lookups to this polls only.
      Compliance:
      mandatory - This method is must be implemented.

    • getVoteEnablerIdsForVote

      IdList getVoteEnablerIdsForVote(Id voteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the VoteEnabler Ids associated with a Vote .
      Parameters:
      voteId - Id of the Vote
      Returns:
      the vote enabler Ids
      Throws:
      NotFoundException - voteId is not found
      NullArgumentException - voteId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getVoteEnablersForVote

      VoteEnablerList getVoteEnablersForVote(Id voteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the VoteEnablers associated with a Vote .
      Parameters:
      voteId - Id of the Vote
      Returns:
      the vote enablers
      Throws:
      NotFoundException - voteId is not found
      NullArgumentException - voteId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getVoteIdsForVoteEnabler

      IdList getVoteIdsForVoteEnabler(Id voteEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Vote Ids mapped to a VoteEnabler .
      Parameters:
      voteEnablerId - Id of a VoteEnabler
      Returns:
      list of vote Ids
      Throws:
      NotFoundException - voteEnablerId is not found
      NullArgumentException - voteEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getVotesForVoteEnabler

      VoteList getVotesForVoteEnabler(Id voteEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Votes mapped to a VoteEnabler .
      Parameters:
      voteEnablerId - Id of a VoteEnabler
      Returns:
      list of votes
      Throws:
      NotFoundException - voteEnablerId is not found
      NullArgumentException - voteEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.