Interface RaceProcessorEnablerPollsSession

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

This session provides methods to retrieve RaceProcessorEnabler to Polls mappings. a RaceProcessorEnabler may appear in multiple Polls objects. Each polls may have its own authorizations governing who is allowed to look at it.

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

  • Method Details

    • canLookupRaceProcessorEnablerPollsMappings

      boolean canLookupRaceProcessorEnablerPollsMappings()
      Tests if this user can perform lookups of race processor enabler/polls 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.

    • useComparativeRaceProcessorEnablerPollsView

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

    • usePlenaryRaceProcessorEnablerPollsView

      void usePlenaryRaceProcessorEnablerPollsView()
      A complete view of the RaceProcessorEnabler and Polls 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.

    • getRaceProcessorEnablerIdsByPolls

      IdList getRaceProcessorEnablerIdsByPolls(Id pollsId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of RaceProcessorEnablerIds associated with a Polls .
      Parameters:
      pollsId - Id of the Polls
      Returns:
      list of related race processor enabler Ids
      Throws:
      NotFoundException - pollsId is not found
      NullArgumentException - pollsId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRaceProcessorEnablersByPolls

      RaceProcessorEnablerList getRaceProcessorEnablersByPolls(Id pollsId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of race processor enablers associated with a Polls .
      Parameters:
      pollsId - Id of the Polls
      Returns:
      list of related race processor enablers
      Throws:
      NotFoundException - pollsId is not found
      NullArgumentException - pollsId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRaceProcessorEnablerIdsByPolls

      IdList getRaceProcessorEnablerIdsByPolls(IdList pollsIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of RaceProcessorEnablerIds corresponding to a list of Polls .
      Parameters:
      pollsIds - list of polls Ids
      Returns:
      list of race processor enabler Ids
      Throws:
      NullArgumentException - pollsIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRaceProcessorEnablersByPolls

      RaceProcessorEnablerList getRaceProcessorEnablersByPolls(IdList pollsIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of race processor enablers corresponding to a list of Polls .
      Parameters:
      pollsIds - list of polls Ids
      Returns:
      list of race processor enablers
      Throws:
      NullArgumentException - pollsIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getPollsIdsByRaceProcessorEnabler

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

    • getPollsByRaceProcessorEnabler

      PollsList getPollsByRaceProcessorEnabler(Id raceProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Polls mapped to a RaceProcessorEnabler .
      Parameters:
      raceProcessorEnablerId - Id of a RaceProcessorEnabler
      Returns:
      list of polls
      Throws:
      NotFoundException - raceProcessorEnablerId is not found
      NullArgumentException - raceProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.