Interface RaceQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
RaceSearchSession
public interface RaceQuerySession extends OsidSession

This session provides methods for searching among races. The race query is constructed using the RaceQuery .

This session defines views that offer differing behaviors for searching.

  • federated polls view: searches include races in polls of which this polls is an ancestor in the polls hierarchy
  • isolated polls view: searches are restricted to races in this polls only

  • 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 associated with this session
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSearchRaces

      boolean canSearchRaces()
      Tests if this user can perform Race searches. 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 search operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedPollsView

      void useFederatedPollsView()
      Federates the view for methods in this session. A federated view will include races 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.

    • getRaceQuery

      RaceQuery getRaceQuery()
      Gets a race query.
      Returns:
      the race query
      Compliance:
      mandatory - This method must be implemented.

    • getRacesByQuery

      RaceList getRacesByQuery(RaceQuery raceQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of races matching the given race qiery.
      Parameters:
      raceQuery - the race query
      Returns:
      the returned RaceList
      Throws:
      NullArgumentException - raceQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - raceQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.