Interface VoteEnablerLookupSession

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

This session provides methods for retrieving VoteEnablers .

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 vote enabler methods in this session operate, retrieve and pertain to vote enablers defined explicitly in the current polls Using an isolated view is useful for managing VoteEnablers with the VoteEnablerAdminSession .
  • federated polls view: All vote enabler 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.

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 any lookup methods.

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

    • canLookupVoteEnablers

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

    • useComparativeVoteEnablerView

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

    • usePlenaryVoteEnablerView

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

    • getVoteEnabler

      VoteEnabler getVoteEnabler(Id voteEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the VoteEnabler specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned VoteEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to a VoteEnabler and retai ned for compatibility.
      Parameters:
      voteEnablerId - Id of the VoteEnabler
      Returns:
      the vote enabler
      Throws:
      NotFoundException - voteEnablerId not found
      NullArgumentException - voteEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getVoteEnablersByIds

      VoteEnablerList getVoteEnablersByIds(IdList voteEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a VoteEnablerList corresponding to the given IdList . In plenary mode, the returned list contains all of the vote 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 VoteEnablers may be omi tted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      voteEnablerIds - the list of Ids to retrieve
      Returns:
      the returned VoteEnabler list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - voteEnablerIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getVoteEnablersByGenusType

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

    • getVoteEnablersByParentGenusType

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

    • getVoteEnablersByRecordType

      VoteEnablerList getVoteEnablersByRecordType(Type voteEnablerRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a VoteEnablerList containing the given vote enabler record Type . In plenary mode, the returned list contains all known vote enablers or an error results. Otherwise, the returned list may contain only those vote enablers that are accessible through this session.
      Parameters:
      voteEnablerRecordType - a vote enabler record type
      Returns:
      the returned VoteEnabler list
      Throws:
      NullArgumentException - voteEnablerRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getVoteEnablers

      VoteEnablerList getVoteEnablers() throws OperationFailedException, PermissionDeniedException
      Gets all VoteEnablers . In plenary mode, the returned list contains all known vote enablers or an error results. Otherwise, the returned list may contain only those vote enablers that are accessible through this session.
      Returns:
      a list of VoteEnablers
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.