.. _module-checkinout:

=====================
Module: checkinout.py
=====================

:Author:    Stefan Eletzhofer
:Date:      2012-07-10

Abstract
========

This module offers functions to **iterate** business objects.

Usage Example
=============

To *check out* a document, do::

    >>> from nexiles.tools.api import get_resource
    >>> from nexiles.tools.api.checkinout import checkin, checkout, undo_checkout
    >>> resource = get_resource("document")
    >>> doc_co = checkout(resource, oid="OR:wt.doc.WTDocument:12345",
    ... message="checkout message")


This will check out the `WTDocument` with the given OID -- see also :ref:`resources`.

The `checkin` and `undo_checkout` functions work similar.

Module Documentation
====================

.. automodule:: nexiles.tools.api.checkinout
   :members:


.. vim: set ft=rst tw=75 nocin nosi ai sw=4 ts=4 expandtab: