org.models.search
=================

.. py:module:: org.models.search


Classes
-------

.. autoapisummary::

   org.models.search.Search


Module Contents
---------------

.. py:class:: Search(request: onegov.org.request.OrgRequest, query: str, page: int)

   Bases: :py:obj:`onegov.core.collection.Pagination`\ [\ :py:obj:`onegov.core.collection._M`\ ]


   Provides collections with pagination, if they implement a few
   documented properties and methods.

   See :class:`onegov.ticket.TicketCollection` for an example.



   .. py:attribute:: results_per_page
      :value: 10



   .. py:attribute:: max_query_length
      :value: 100



   .. py:attribute:: request


   .. py:attribute:: query


   .. py:property:: available_documents
      :type: int



   .. py:property:: explain
      :type: bool



   .. py:property:: q
      :type: str



   .. py:method:: __eq__(other: object) -> bool

      Returns True if the current and the other Pagination instance
      are equal. Used to find the current page in a list of pages.




   .. py:property:: cached_subset
      :type: onegov.search.dsl.Response | None



   .. py:method:: subset() -> onegov.search.dsl.Response | None

      Returns an SQLAlchemy query containing all records that should
      be considered for pagination.




   .. py:property:: page_index
      :type: int


      Returns the current page index (starting at 0). 



   .. py:method:: page_by_index(index: int) -> Search[onegov.core.collection._M]

      Returns the page at the given index. A page here means an instance
      of the class inheriting from the ``Pagination`` base class.




   .. py:property:: batch
      :type: onegov.search.dsl.Response | None


      Returns the elements on the current page. 



   .. py:property:: load_batch_results
      :type: list[onegov.search.dsl.Hit]


      Load search results and sort events by latest occurrence.

      This methods is a wrapper around `batch.load()`, which returns the
      actual search results form the query. 



   .. py:method:: generic_search(search: onegov.search.dsl.Search, query: str) -> onegov.search.dsl.Search


   .. py:method:: hashtag_search(search: onegov.search.dsl.Search, query: str) -> onegov.search.dsl.Search


   .. py:method:: feeling_lucky() -> str | None


   .. py:property:: subset_count
      :type: int


      Returns the total number of elements this pagination represents.

              



   .. py:method:: suggestions() -> tuple[str, Ellipsis]