Interface RaceProcessorEnablerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, RaceProcessorEnablerQuerySession
public interface RaceProcessorEnablerSearchSession extends RaceProcessorEnablerQuerySession

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

getRaceProcessorEnablersByQuery() is the basic search method and returns a list of RaceProcessorEnablers. A more advanced search may be performed with getRaceProcessorEnablersBySearch().It accepts a RaceProcessorEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as voting. getRaceProcessorEnablersBySearch() returns a RaceProcessorEnablerSearchResults that can be used to access the resulting RaceProcessorEnablerList or be used to perform a search within the result set through RaceProcessorEnablerSearch.

This session defines views that offer differing behaviors for searching.

  • federated polls view: searches include race processor enablers in polls of which this polls is an ancestor in the polls hierarchy
  • isolated polls view: searches are restricted to race processor enablers in this polls
RaceProcessorEnablers may have a query record indicated by their respective query record types. The record is accessed via the RaceProcessorEnablerQuery.

  • Method Details

    • getRaceProcessorEnablerSearch

      RaceProcessorEnablerSearch getRaceProcessorEnablerSearch()
      Gets a race processor enabler search.
      Returns:
      the race processor enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getRaceProcessorEnablerSearchOrder

      RaceProcessorEnablerSearchOrder getRaceProcessorEnablerSearchOrder()
      Gets a race processor enabler search order. The RaceProcessorEnablerSearchOrder is supplied to a RaceProcessorEnablerSearch to specify the ordering of results.
      Returns:
      the race processor enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • getRaceProcessorEnablersBySearch

      RaceProcessorEnablerSearchResults getRaceProcessorEnablersBySearch(RaceProcessorEnablerQuery raceProcessorEnablerQuery, RaceProcessorEnablerSearch raceProcessorEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      raceProcessorEnablerQuery - the race processor enabler query
      raceProcessorEnablerSearch - the race processor enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - raceProcessorEnablerQuery or raceProcessorEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - raceProcessorEnablerQuery or raceProcessorEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getRaceProcessorEnablerQueryFromInspector

      RaceProcessorEnablerQuery getRaceProcessorEnablerQueryFromInspector(RaceProcessorEnablerQueryInspector raceProcessorEnablerQueryInspector)
      Gets a race processor enabler query from an inspector. The inspector is available from a RaceProcessorEnablerSearchResults.
      Parameters:
      raceProcessorEnablerQueryInspector - a race processor enabler query inspector
      Returns:
      the race processor enabler query
      Throws:
      NullArgumentException - raceProcessorEnablerQueryInspector is null
      UnsupportedException - raceProcessorEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.