Interface BallotConstrainerLookupSession

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

This session provides methods for retrieving BallotConstrainers .

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated polls view: All ballot constrainer methods in this session operate, retrieve and pertain to ballot constrainer defined explicitly in the current polls. Using an isolated view is useful for managing BallotConstrainers with the BallotConstrainerAdminSession .
  • federated polls view: All ballot constrainer methods in this session operate, retrieve and pertain to all ballot constrainer defined in this polls and any other ballot constrainer implicitly available in this polls through polls inheritence.
  • active ballot constrainer view: All ballot constrainer lookup methods return active ballot constrainers.
  • any status authorization enabler view: Ballit constrainers of any active or inactive status are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedPollsView() and useIsolatedPollsView() behave as a radio group and one should be selected before invoking the methods in this session.

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

    • canLookupBallotConstrainers

      boolean canLookupBallotConstrainers()
      Tests if this user can perform BallotConstrainers lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeBallotConstrainerView

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

    • usePlenaryBallotConstrainerView

      void usePlenaryBallotConstrainerView()
      A complete view of the 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 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.

    • useActiveBallotConstrainerView

      void useActiveBallotConstrainerView()
      Only active ballot constrainers are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusBallotConstrainerView

      void useAnyStatusBallotConstrainerView()
      All active and inactive ballot constrainers are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getBallotConstrainer

      BallotConstrainer getBallotConstrainer(Id ballotConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the BallotConstrainer specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned BallotConstrainer may have a different Id than requested, such as the case where a duplicate Id was assigned to a BallotConstrainer and retained for compatibility. In active mode, ballot constrainers are returned that are currently active. In any status mode, active and inactive ballot constrainers are returned.
      Parameters:
      ballotConstrainerId - Id of the BallotConstrainer
      Returns:
      the ballot constrainer
      Throws:
      NotFoundException - ballotConstrainerId not found
      NullArgumentException - ballotConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getBallotConstrainersByIds

      BallotConstrainerList getBallotConstrainersByIds(IdList ballotConstrainerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a BallotConstrainerList corresponding to the given IdList . In plenary mode, the returned list contains all of the ballot constrainer specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible BallotConstrainers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, ballot constrainers are returned that are currently active. In any status mode, active and inactive ballot constrainers are returned.
      Parameters:
      ballotConstrainerIds - the list of Ids to retrieve
      Returns:
      the returned BallotConstrainer list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - ballotConstrainerIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBallotConstrainersByGenusType

      BallotConstrainerList getBallotConstrainersByGenusType(Type ballotConstrainerGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a BallotConstrainerList corresponding to the given ballot constrainer genus Type which does not include ballot constrainer of genus types derived from the specified Type . In plenary mode, the returned list contains all known ballot constrainer or an error results. Otherwise, the returned list may contain only those ballot constrainer that are accessible through this session. In active mode, ballot constrainers are returned that are currently active. In any status mode, active and inactive ballot constrainers are returned.
      Parameters:
      ballotConstrainerGenusType - a ballot constrainer genus type
      Returns:
      the returned BallotConstrainer list
      Throws:
      NullArgumentException - ballotConstrainerGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBallotConstrainersByParentGenusType

      BallotConstrainerList getBallotConstrainersByParentGenusType(Type ballotConstrainerGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a BallotConstrainerList corresponding to the given ballot constrainer genus Type and include any additional ballot constrainer with genus types derived from the specified Type . In plenary mode, the returned list contains all known ballot constrainer or an error results. Otherwise, the returned list may contain only those ballot constrainer that are accessible through this session. In active mode, ballot constrainers are returned that are currently active. In any status mode, active and inactive ballot constrainers are returned.
      Parameters:
      ballotConstrainerGenusType - a ballot constrainer genus type
      Returns:
      the returned BallotConstrainer list
      Throws:
      NullArgumentException - ballotConstrainerGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBallotConstrainersByRecordType

      BallotConstrainerList getBallotConstrainersByRecordType(Type ballotConstrainerRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a BallotConstrainerList containing the given ballot constrainer record Type . In plenary mode, the returned list contains all known ballot constrainer or an error results. Otherwise, the returned list may contain only those ballot constrainer that are accessible through this session. In active mode, ballot constrainers are returned that are currently active. In any status mode, active and inactive ballot constrainers are returned.
      Parameters:
      ballotConstrainerRecordType - a ballot constrainer record type
      Returns:
      the returned BallotConstrainer list
      Throws:
      NullArgumentException - ballotConstrainerRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBallotConstrainers

      BallotConstrainerList getBallotConstrainers() throws OperationFailedException, PermissionDeniedException
      Gets all BallotConstrainers . In plenary mode, the returned list contains all known ballot constrainer or an error results. Otherwise, the returned list may contain only those ballot constrainer that are accessible through this session. In active mode, ballot constrainers are returned that are currently active. In any status mode, active and inactive ballot constrainers are returned.
      Returns:
      the returned BallotConstrainer list
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.