Changeset 1479 in main

Timestamp:

07/17/12 10:05:36 (10 years ago)

Author:

pcosquer

Message:

plmapp: docs

File:

• trunk/openPLM/plmapp/controllers/part.py (modified) (6 diffs)

trunk/openPLM/plmapp/controllers/part.py

@@ -106 +106 @@
         :type order: positive int
         :param unit: a valid unit
+
+        Extra arguments are used to create relevant :class:`.ParentChildLinkExtension`.
         
         :raises: :exc:`ValueError` if *child* is already a child or a parent.
@@ -144 +146 @@
 
         .. note::
-            The link is not destroyed: its end_time is set to now.
+            The link is not destroyed: its :attr:`.ParentChildLink.end_time`
+            is set to now.
         
         :raises: :exc:`.PermissionError` if :attr:`_user` is not the owner of
@@ -171 +174 @@
         :param new_order: order
         :type new_order: positive int
+        
+        Extra arguments are used to modify relevant :class:`.ParentChildLinkExtension`.
         
         :raises: :exc:`.PermissionError` if :attr:`_user` is not the owner of
@@ -261 +266 @@
         Returns a list of all children at time *date*.
         
+        :param max_level: maximum level of children, ``-1``
+            returns all descendants, ``1`` returns direct children
+        :param related: a list of related fields that are given
+            to retrieve the :class:`.ParentChildLink`
+        :param only_official: True if the result should be pruned to
+            only include official children
+        :param only: a list of fields that are given to limit the
+            retrieved field of the :class:`.ParentChildLink`
         :rtype: list of :class:`Child`
         """
@@ -335 +348 @@
     def get_parents(self, max_level=1, date=None,
             related=("parent", "parent__state", "parent__lifecycle"),
-            only_official=False):
+            only_official=False, only=None):
         """
         Returns a list of all parents at time *date*.
         
+        :param max_level: maximum level of parents, ``-1``
+            returns all ancestors, ``1`` returns direct parents
+        :param related: a list of related fields that are given
+            to retrieve the :class:`.ParentChildLink`
+        :param only_official: True if the result should be pruned to
+            only include official parents
+        :param only: a list of fields that are given to limit the
+            retrieved field of the :class:`.ParentChildLink`
         :rtype: list of :class:`Parent`
         """
@@ -348 +369 @@
         else:
             links = objects.filter(ctime__lte=date).exclude(end_time__lt=date)
+        if only is not None:
+            links = links.only(*only)
         res = []
         children = [self.object.id]