org.models.resource
===================

.. py:module:: org.models.resource


Classes
-------

.. autoapisummary::

   org.models.resource.FindYourSpotCollection
   org.models.resource.SharedMethods
   org.models.resource.DaypassResource
   org.models.resource.RoomResource
   org.models.resource.ItemResource


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

.. py:class:: FindYourSpotCollection(libres_context: libres.context.core.Context, group: str | None)

   Bases: :py:obj:`onegov.reservation.ResourceCollection`


   Manages a list of resources.

       


   .. py:attribute:: group


   .. py:property:: title
      :type: str



   .. py:property:: meta
      :type: dict[str, Any]



   .. py:method:: query() -> sqlalchemy.orm.Query[onegov.reservation.Resource]


.. py:class:: SharedMethods

   .. py:attribute:: title_template
      :type:  ClassVar[str]


   .. py:attribute:: lead
      :type:  onegov.core.orm.mixins.dict_property[str | None]


   .. py:attribute:: text


   .. py:attribute:: occupancy_is_visible_to_members
      :type:  onegov.core.orm.mixins.dict_property[bool | None]


   .. py:property:: deletable
      :type: bool



   .. py:property:: future_managed_reservations
      :type: sqlalchemy.orm.Query[onegov.reservation.Reservation]



   .. py:property:: future_managed_reserved_slots
      :type: sqlalchemy.orm.Query[libres.db.models.ReservedSlot]



   .. py:property:: calendar_date_range
      :type: tuple[datetime.datetime, datetime.datetime]


      Returns the date range set by the fullcalendar specific params. 



   .. py:method:: remove_expired_reservation_sessions(expiration_date: datetime.datetime | None = None) -> None


   .. py:method:: bound_reservations(request: onegov.org.request.OrgRequest, status: str = 'pending') -> sqlalchemy.orm.Query[onegov.reservation.Reservation]

      The reservations associated with this resource and user. 



   .. py:method:: bound_session_id(request: onegov.org.request.OrgRequest) -> uuid.UUID

      The session id associated with this resource and user. 



   .. py:method:: reservations_with_tickets_query(start: datetime.datetime | None = None, end: datetime.datetime | None = None, exclude_pending: bool = True) -> sqlalchemy.orm.Query[onegov.reservation.Reservation]

      Returns a query which joins this resource's reservations between
      start and end with the tickets table.




   .. py:method:: reservation_title(reservation: onegov.reservation.Reservation) -> str


.. py:class:: DaypassResource

   Bases: :py:obj:`onegov.reservation.Resource`, :py:obj:`onegov.org.models.extensions.AccessExtension`, :py:obj:`onegov.search.SearchableContent`, :py:obj:`onegov.org.models.extensions.ContactExtension`, :py:obj:`onegov.org.models.extensions.PersonLinkExtension`, :py:obj:`onegov.org.models.extensions.CoordinatesExtension`, :py:obj:`SharedMethods`, :py:obj:`onegov.org.models.extensions.ResourceValidationExtension`, :py:obj:`onegov.org.models.extensions.GeneralFileLinkExtension`


   A resource holds a single calendar with allocations and reservations.

   Note that this resource is not defined on the onegov.core declarative base.
   Instead it is defined using the libres base. This means we can't join
   data outside the libres models.

   This should however not be a problem as this onegov module is self
   contained and does not link to other onegov modules, except for core.

   If we ever want to link to other models (say link a reservation to a user),
   then we have to switch to a unified base. Ideally we would find a way
   to merge these bases somehow.

   Also note that we *do* use the ModelBase class as a mixin to at least share
   the same methods as all the usual onegov.core.orm models.



   .. py:attribute:: __mapper_args__


   .. py:attribute:: es_type_name
      :value: 'daypasses'


      Returns the unique type name of the model. 



   .. py:attribute:: view
      :value: 'month'



   .. py:attribute:: show_quota
      :value: True



   .. py:attribute:: title_template
      :value: '{start:%d.%m.%Y} ({quota})'



.. py:class:: RoomResource

   Bases: :py:obj:`onegov.reservation.Resource`, :py:obj:`onegov.org.models.extensions.AccessExtension`, :py:obj:`onegov.search.SearchableContent`, :py:obj:`onegov.org.models.extensions.ContactExtension`, :py:obj:`onegov.org.models.extensions.PersonLinkExtension`, :py:obj:`onegov.org.models.extensions.CoordinatesExtension`, :py:obj:`SharedMethods`, :py:obj:`onegov.org.models.extensions.ResourceValidationExtension`, :py:obj:`onegov.org.models.extensions.GeneralFileLinkExtension`


   A resource holds a single calendar with allocations and reservations.

   Note that this resource is not defined on the onegov.core declarative base.
   Instead it is defined using the libres base. This means we can't join
   data outside the libres models.

   This should however not be a problem as this onegov module is self
   contained and does not link to other onegov modules, except for core.

   If we ever want to link to other models (say link a reservation to a user),
   then we have to switch to a unified base. Ideally we would find a way
   to merge these bases somehow.

   Also note that we *do* use the ModelBase class as a mixin to at least share
   the same methods as all the usual onegov.core.orm models.



   .. py:attribute:: __mapper_args__


   .. py:attribute:: es_type_name
      :value: 'rooms'


      Returns the unique type name of the model. 



   .. py:attribute:: view
      :value: None



   .. py:attribute:: show_quota
      :value: False



   .. py:attribute:: title_template
      :value: '{start:%d.%m.%Y} {start:%H:%M} - {end:%H:%M}'



   .. py:property:: deletable
      :type: bool



.. py:class:: ItemResource

   Bases: :py:obj:`onegov.reservation.Resource`, :py:obj:`onegov.org.models.extensions.AccessExtension`, :py:obj:`onegov.search.SearchableContent`, :py:obj:`onegov.org.models.extensions.ContactExtension`, :py:obj:`onegov.org.models.extensions.PersonLinkExtension`, :py:obj:`onegov.org.models.extensions.CoordinatesExtension`, :py:obj:`SharedMethods`, :py:obj:`onegov.org.models.extensions.ResourceValidationExtension`, :py:obj:`onegov.org.models.extensions.GeneralFileLinkExtension`


   A resource holds a single calendar with allocations and reservations.

   Note that this resource is not defined on the onegov.core declarative base.
   Instead it is defined using the libres base. This means we can't join
   data outside the libres models.

   This should however not be a problem as this onegov module is self
   contained and does not link to other onegov modules, except for core.

   If we ever want to link to other models (say link a reservation to a user),
   then we have to switch to a unified base. Ideally we would find a way
   to merge these bases somehow.

   Also note that we *do* use the ModelBase class as a mixin to at least share
   the same methods as all the usual onegov.core.orm models.



   .. py:attribute:: __mapper_args__


   .. py:attribute:: es_type_name
      :value: 'daily_items'


      Returns the unique type name of the model. 



   .. py:attribute:: view
      :value: None



   .. py:attribute:: show_quota
      :value: True



   .. py:attribute:: title_template
      :value: '{start:%d.%m.%Y} {start:%H:%M} - {end:%H:%M} ({quota})'