Interface BallotConstrainerEnablerRuleLookupSession

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

This session provides methods to retrieve BallotConstrainerEnabler to BallotConstrainer mappings. A BallotConstrainer with multiple BallotConstrainerEnablers means any positive rule evaluation across the enablers result in an effective BallotConstrainer .

This 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 ballot constrainer enablers defined explicitly in the current polls
  • federated polls view: All methods in this session operate, retrieve and pertain to all ballot constrainer enablers defined in this polls and any other ballot constrainer 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.

    • canLookupBallotConstrainerEnablerRules

      boolean canLookupBallotConstrainerEnablerRules()
      Tests if this user can perform lookups of ballot constrainer enabler/ballot constrainer 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.

    • useComparativeBallotConstrainerEnablerRuleView

      void useComparativeBallotConstrainerEnablerRuleView()
      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.

    • usePlenaryBallotConstrainerEnablerRuleView

      void usePlenaryBallotConstrainerEnablerRuleView()
      A complete view of the BallotConstrainerEnabler and BallotConstrainer 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 ballot constrainer 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.

    • getBallotConstrainerEnablerIdsForBallotConstrainer

      IdList getBallotConstrainerEnablerIdsForBallotConstrainer(Id ballotConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the BallotConstrainerEnablerId associated with a BallotConstrainer .
      Parameters:
      ballotConstrainerId - Id of the BallotConstrainer
      Returns:
      the ballot constrainer enabler Ids
      Throws:
      NotFoundException - ballotConstrainerId is not found
      NullArgumentException - ballotConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBallotConstrainerEnablersForBallotConstrainer

      BallotConstrainerEnablerList getBallotConstrainerEnablersForBallotConstrainer(Id ballotConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the BallotConstrainerEnablers associated with a BallotConstrainer .
      Parameters:
      ballotConstrainerId - Id of the BallotConstrainer
      Returns:
      the ballot constrainer enablers
      Throws:
      NotFoundException - ballotConstrainerId is not found
      NullArgumentException - ballotConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBallotConstrainerIdsForBallotConstrainerEnabler

      IdList getBallotConstrainerIdsForBallotConstrainerEnabler(Id ballotConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the BallotConstrainer Ids mapped to a BallotConstrainerEnabler .
      Parameters:
      ballotConstrainerEnablerId - Id of a BallotConstrainerEnabler
      Returns:
      list of ballot constrainer Ids
      Throws:
      NotFoundException - ballotConstrainerEnablerId is not found
      NullArgumentException - ballotConstrainerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBallotConstrainersForBallotConstrainerEnabler

      BallotConstrainerList getBallotConstrainersForBallotConstrainerEnabler(Id ballotConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the BallotConstrainers mapped to a BallotConstrainerEnabler .
      Parameters:
      ballotConstrainerEnablerId - Id of a BallotConstrainerEnabler
      Returns:
      list of ballot constrainers
      Throws:
      NotFoundException - ballotConstrainerEnablerId is not found
      NullArgumentException - ballotConstrainerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.