Interface RaceProcessorEnablerRuleLookupSession

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

This session provides methods to retrieve RaceProcessorEnabler to RaceProcessor mappings. a RaceProcessor with multiple RaceProcessorEnablers means any positive rule evaluation across the enablers result in an effective RaceProcessor .

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

    • canLookupRaceProcessorEnablerRules

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

    • useComparativeRaceProcessorEnablerRuleView

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

    • usePlenaryRaceProcessorEnablerRuleView

      void usePlenaryRaceProcessorEnablerRuleView()
      A complete view of the RaceProcessorEnabler and RaceProcessor 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 race processor 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.

    • getRaceProcessorEnablerIdsForRaceProcessor

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

    • getRaceProcessorEnablersForRaceProcessor

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

    • getRaceProcessorIdsForRaceProcessorEnabler

      IdList getRaceProcessorIdsForRaceProcessorEnabler(Id raceProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the RaceProcessor Ids mapped to a RaceProcessorEnabler .
      Parameters:
      raceProcessorEnablerId - Id of a RaceProcessorEnabler
      Returns:
      list of race processor Ids
      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.

    • getRaceProcessorsForRaceProcessorEnabler

      RaceProcessorList getRaceProcessorsForRaceProcessorEnabler(Id raceProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the RaceProcessors mapped to a RaceProcessorEnabler .
      Parameters:
      raceProcessorEnablerId - Id of a RaceProcessorEnabler
      Returns:
      list of race processors
      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.