page.collection
===============

.. py:module:: page.collection


Classes
-------

.. autoapisummary::

   page.collection.PageCollection


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

.. py:class:: PageCollection(session: sqlalchemy.orm.session.Session)

   Bases: :py:obj:`onegov.core.orm.abstract.AdjacencyListCollection`\ [\ :py:obj:`onegov.page.model.Page`\ ]


   Manages a hierarchy of pages.

   Use it like this:

       from onegov.page import PageCollection
       pages = PageCollection(session)



   .. py:attribute:: __listclass__

      The list class this collection handles. Must inherit from
      :class:`AdjacencyList`.




   .. py:method:: copy(page: onegov.page.model.Page, parent: onegov.page.model.Page | None) -> onegov.page.model.Page

      Takes the given page and copies it to a given parent.

      The parent may be the same as the given page or another. If there's
      a conflict with existing children, the name is adjusted using
      :meth:`get_unique_child_name`.