agency.models.move
==================

.. py:module:: agency.models.move


Attributes
----------

.. autoapisummary::

   agency.models.move._M
   agency.models.move._M_co
   agency.models.move._IdT_contra


Classes
-------

.. autoapisummary::

   agency.models.move.SupportsById
   agency.models.move.Move
   agency.models.move.AgencyMove
   agency.models.move.AgencyMembershipMoveWithinAgency
   agency.models.move.AgencyMembershipMoveWithinPerson


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

.. py:data:: _M

.. py:data:: _M_co

.. py:data:: _IdT_contra

.. py:class:: SupportsById

   Bases: :py:obj:`Protocol`\ [\ :py:obj:`_M_co`\ , :py:obj:`_IdT_contra`\ ]


   .. py:method:: by_id(id: _IdT_contra, /) -> _M_co | None


.. py:class:: Move(session: sqlalchemy.orm.Session, subject_id: _IdT_contra, target_id: _IdT_contra, direction: onegov.core.orm.abstract.MoveDirection)

   Bases: :py:obj:`Generic`\ [\ :py:obj:`_M`\ , :py:obj:`_IdT_contra`\ ]


   Base class for moving things. 


   .. py:attribute:: session


   .. py:attribute:: subject_id


   .. py:attribute:: target_id


   .. py:attribute:: direction


   .. py:property:: collection
      :type: SupportsById[_M, _IdT_contra]

      :abstractmethod:



   .. py:property:: subject
      :type: _M | None



   .. py:property:: target
      :type: _M | None



   .. py:method:: execute() -> None
      :abstractmethod:



.. py:class:: AgencyMove(session: sqlalchemy.orm.Session, subject_id: _IdT_contra, target_id: _IdT_contra, direction: onegov.core.orm.abstract.MoveDirection)

   Bases: :py:obj:`Move`\ [\ :py:obj:`onegov.agency.models.ExtendedAgency`\ , :py:obj:`int`\ ]


   Represents a single move of a suborganization. 


   .. py:property:: collection
      :type: onegov.agency.collections.ExtendedAgencyCollection



   .. py:method:: execute() -> None


.. py:class:: AgencyMembershipMoveWithinAgency(session: sqlalchemy.orm.Session, subject_id: _IdT_contra, target_id: _IdT_contra, direction: onegov.core.orm.abstract.MoveDirection)

   Bases: :py:obj:`Move`\ [\ :py:obj:`onegov.people.AgencyMembership`\ , :py:obj:`uuid.UUID`\ ]


   Represents a single move of a membership with respect to a Agency. 


   .. py:property:: collection
      :type: onegov.people.AgencyMembershipCollection



   .. py:method:: execute() -> None


.. py:class:: AgencyMembershipMoveWithinPerson(session: sqlalchemy.orm.Session, subject_id: _IdT_contra, target_id: _IdT_contra, direction: onegov.core.orm.abstract.MoveDirection)

   Bases: :py:obj:`Move`\ [\ :py:obj:`onegov.people.AgencyMembership`\ , :py:obj:`uuid.UUID`\ ]


   Represents a single move of a membership with respect to a Person. 


   .. py:property:: collection
      :type: onegov.people.AgencyMembershipCollection



   .. py:method:: execute() -> None