Interface RaceConstrainerEnablerRuleLookupSession

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

This session provides methods to retrieve RaceConstrainerEnabler to RaceConstrainer mappings. a Race with multiple RaceConstrainerEnablers means any positive rule evaluation across the enablers result in an effective RaceConstrainer .

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

    • canLookupRaceConstrainerEnablerRules

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

    • useComparativeRaceConstrainerEnablerRuleView

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

    • usePlenaryRaceConstrainerEnablerRuleView

      void usePlenaryRaceConstrainerEnablerRuleView()
      A complete view of the RaceConstrainerEnabler and RaceConstrainer 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 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.

    • getRaceConstrainerEnablerIdsForRaceConstrainer

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

    • getRaceConstrainerEnablersForRaceConstrainer

      RaceConstrainerEnablerList getRaceConstrainerEnablersForRaceConstrainer(Id raceConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the RaceConstrainerEnablers associated with a RaceConstrainer .
      Parameters:
      raceConstrainerId - Id of the RaceConstrainer
      Returns:
      the race constrainer enablers
      Throws:
      NotFoundException - raceConstrainerId is not found
      NullArgumentException - raceConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRaceConstrainerIdsForRaceConstrainerEnabler

      IdList getRaceConstrainerIdsForRaceConstrainerEnabler(Id raceConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the RaceConstrainer Ids mapped to a RaceConstrainerEnabler .
      Parameters:
      raceConstrainerEnablerId - Id of a RaceConstrainerEnabler
      Returns:
      list of race constrainer Ids
      Throws:
      NotFoundException - raceConstrainerEnablerId is not found
      NullArgumentException - raceConstrainerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRaceConstrainersForRaceConstrainerEnabler

      RaceConstrainerList getRaceConstrainersForRaceConstrainerEnabler(Id raceConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the RaceConstrainers mapped to a RaceConstrainerEnabler .
      Parameters:
      raceConstrainerEnablerId - Id of a RaceConstrainerEnabler
      Returns:
      list of race constrainers
      Throws:
      NotFoundException - raceConstrainerEnablerId is not found
      NullArgumentException - raceConstrainerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.