Interface BallotConstrainerEnablerLookupSession

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

This session provides methods for retrieving BallotConstrainerEnablers .

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 enabler methods in this session operate, retrieve and pertain to ballot constrainer enablers defined explicitly in the current polls. Using an isolated view is useful for managing BallotConstrainerEnablers with the BallotConstrainerEnablerAdminSession .
  • federated polls view: All ballot constrainer enabler 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.
  • active ballot constrainer enabler view: All ballot constrainer enabler lookup methods return active ballot constrainer enablers.
  • any status ballot constrainer enabler view: Ballot constrainer enablers 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.

    • canLookupBallotConstrainerEnablers

      boolean canLookupBallotConstrainerEnablers()
      Tests if this user can perform BallotConstrainerEnablers 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.

    • useComparativeBallotConstrainerEnablerView

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

    • usePlenaryBallotConstrainerEnablerView

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

    • useActiveBallotConstrainerEnablerView

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

    • useAnyStatusBallotConstrainerEnablerView

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

    • getBallotConstrainerEnabler

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

    • getBallotConstrainerEnablersByIds

      BallotConstrainerEnablerList getBallotConstrainerEnablersByIds(IdList ballotConstrainerEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a BallotConstrainerEnablerList corresponding to the given IdList . In plenary mode, the returned list contains all of the ballot constrainer enablers 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 BallotConstrainerEnablers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, ballot constrainer enablers are returned that are currently active. In any status mode, active and inactive ballot constrainer enablers are returned.
      Parameters:
      ballotConstrainerEnablerIds - the list of Ids to retrieve
      Returns:
      the returned BallotConstrainerEnabler list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - ballotConstrainerEnablerIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBallotConstrainerEnablersByGenusType

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

    • getBallotConstrainerEnablersByParentGenusType

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

    • getBallotConstrainerEnablersByRecordType

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

    • getBallotConstrainerEnablersOnDate

      BallotConstrainerEnablerList getBallotConstrainerEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a BallotConstrainerEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known ballot constrainer enablers or an error results. Otherwise, the returned list may contain only those ballot constrainer enablers that are accessible through this session. In active mode, ballot constrainer enablers are returned that are currently active. In any status mode, active and inactive ballot constrainer enablers are returned.
      Parameters:
      from - a start date
      to - an end date
      Returns:
      the returned BallotConstrainerEnabler list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBallotConstrainerEnablersOnDateWithAgent

      BallotConstrainerEnablerList getBallotConstrainerEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a BallotConstrainerEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known ballot constrainer enablers or an error results. Otherwise, the returned list may contain only those ballot constrainer enablers that are accessible through this session. In active mode, ballot constrainer enablers are returned that are currently active. In any status mode, active and inactive ballot constrainer enablers are returned.
      Parameters:
      agentId - an agent Id
      from - a start date
      to - an end date
      Returns:
      the returned BallotConstrainerEnabler list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - agentId, from , or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBallotConstrainerEnablers

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