Document: improve the API of move_to()

bzr revid: p_christ@hol.gr-20100701175132-s9y160v1etxt1ugp
This commit is contained in:
P. Christeas
2010-07-01 20:51:32 +03:00
parent d52f451bca
commit 493fe42f13
+4 -3
View File
@@ -212,14 +212,15 @@ class node_class(object):
def get_dav_eprop(self, cr, ns, prop):
return None
def move_to(self, cr, fil_obj, ndir_obj, new_name=False, in_write=False):
def move_to(self, cr, ndir_node, new_name=False, fil_obj=None, ndir_obj=None, in_write=False):
""" Move this node to a new parent directory.
@param ndir_node the collection that this node should be moved under
@param new_name a name to rename this node to. If omitted, the old
name is preserved
@param fil_obj, can be None, is the browse object for the file,
if already available.
@param ndir_obj must be the browse object to the new doc.directory
location, where this node should be moved to.
@param new_name a name to rename this node to. If omitted, the old
name is preserved
in_write: When called by write(), we shouldn't attempt to write the
object, but instead return the dict of vals (avoid re-entrance).
If false, we should write all data to the object, here, as if the