people.collections.memberships
==============================

.. py:module:: people.collections.memberships


Classes
-------

.. autoapisummary::

   people.collections.memberships.AgencyMembershipCollection


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

.. py:class:: AgencyMembershipCollection(session: sqlalchemy.orm.Session, **kwargs: Any)

   Bases: :py:obj:`onegov.core.collection.GenericCollection`\ [\ :py:obj:`onegov.people.models.AgencyMembership`\ ]


   Manages a list of agency memberships.

   Use it like this::

       from onegov.people import AgencyMembershipCollection
       memberships = AgencyMembershipCollection(session)



   .. py:property:: model_class
      :type: type[onegov.people.models.AgencyMembership]



   .. py:method:: by_id(id: uuid.UUID) -> onegov.people.models.AgencyMembership | None


   .. py:method:: query(order_by: str | None = None) -> sqlalchemy.orm.Query[onegov.people.models.AgencyMembership]


   .. py:method:: move(subject: onegov.people.models.AgencyMembership, target: onegov.people.models.AgencyMembership, direction: onegov.core.orm.abstract.MoveDirection, move_on_col: Literal['order_within_person', 'order_within_agency']) -> None

      Takes the given subject and moves it somewhere in relation to the
      target.

      :subject:
          The item to be moved.

      :target:
          The item above which or below which the subject is moved.

      :direction:
          The direction relative to the target. Either
          :attr:`MoveDirection.above` if the subject should be moved
          above the target, or :attr:`MoveDirection.below` if the subject
          should be moved below the target.
      :move_on_col:
          Designates the column for which the new order should be evaluated.
          Possible values are `order_within_agency` and
          `order_within_person`.