Document: amend the API for the move_to(), allow rename

It is better to have the same API for both move and rename.

bzr revid: p_christ@hol.gr-20100701175132-qgbf7p4izkh844vg
This commit is contained in:
P. Christeas
2010-07-01 20:51:32 +03:00
parent 530932640b
commit 4052a14c95
+7 -5
View File
@@ -209,12 +209,14 @@ class node_class(object):
def get_dav_eprop(self, cr, ns, prop):
return None
def move_to(self, cr, fil_obj, ndir_obj, in_write=False):
def move_to(self, cr, fil_obj, ndir_obj, new_name=False, in_write=False):
""" Move this node to a new parent directory.
fil_obj, can be None, is the browse object for the file, if already
available.
ndir_obj must be the browse object to the new doc.directory location,
where this node should be moved to.
@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