Interface RaceProcessorQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
RaceProcessorSearchSession
public interface RaceProcessorQuerySession extends OsidSession

This session provides methods for searching among RaceProcessor objects. The search query is constructed using the RaceProcessorQuery .

This session defines views that offer differing behaviors for searching.

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

Race processor may have a query record indicated by their respective record types. The query record is accessed via the RaceProcessorQuery .

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

    • canSearchRaceProcessors

      boolean canSearchRaceProcessors()
      Tests if this user can perform RaceProcessor 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 not offer lookup 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 race processor in polls which are children of this race 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.

    • getRaceProcessorQuery

      RaceProcessorQuery getRaceProcessorQuery()
      Gets a race processor query.
      Returns:
      the race processor query
      Compliance:
      mandatory - This method must be implemented.

    • getRaceProcessorsByQuery

      RaceProcessorList getRaceProcessorsByQuery(RaceProcessorQuery raceProcessorQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of RaceProcessors matching the given race processor query.
      Parameters:
      raceProcessorQuery - the race processor query
      Returns:
      the returned RaceProcessorList
      Throws:
      NullArgumentException - raceProcessorQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - raceProcessorQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.