diff -r 7685cec9fd3c -r f2ddfa555b0f doc/api/python/ccm.Folder-class.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/api/python/ccm.Folder-class.html Fri Sep 11 11:54:49 2009 +0100 @@ -0,0 +1,583 @@ + + + + + ccm.Folder + + + + + + + + + + + + + + + + + + + + +
   Trees      Indices      Help   
+ + + + + +
+ + Package ccm :: + Class Folder + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Class Folder

source code

+
+  object --+        
+           |        
+FourPartName --+    
+               |    
+       CCMObject --+
+                   |
+                  Folder
+
+ +
+Wrapper class for Synergy folder object

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+   + + + + + + +
__init__(self, + session, + fpn)
+ Create a FourPartName object based on a ifpn string.		 + source code + +
+ +
+   + + + + + + +
_gettasks(self)
+ Accessor for 'tasks' property.		 + source code + +
+ +
+   + + + + + + +
_getobjects(self) + source code + +
+ +
+   + + + + + + +
_getmode(self)
+ Get the mode used by the folder.		 + source code + +
+ +
+   + + + + + + +
_getquery(self)
+ Get the query that populate the folder.		 + source code + +
+ +
+   + + + + + + +
_getdescription(self)
+ Get the description associated with the folder.		 + source code + +
+ +
+   + + + + + + +
remove(self, + task)
+ Remove task from this folder.		 + source code + +
+ +
+   + + + + + + +
update(self) + source code + +
+ +
+   + + + + + + +
append(self, + task)
+ Associate an object to a task		 + source code + +
+ +
+   + + + + + + +
copy(self, + existing_folder)
+ Copy the contents of existing_folder into this folder.		 + source code + +
+ +
+   + + + + + + +
objects(self) + source code + +
+ +
+   + + + + + + +
tasks(self)
+ Accessor for 'tasks' property.		 + source code + +
+ +
+   + + + + + + +
mode(self)
+ Get the mode used by the folder.		 + source code + +
+ +
+   + + + + + + +
query(self)
+ Get the query that populate the folder.		 + source code + +
+ +
+   + + + + + + +
description(self)
+ Get the description associated with the folder.		 + source code + +
+ +
+

Inherited from CCMObject: + __getitem__, + __setitem__, + create_attribute, + exists, + finduse, + is_predecessor_of, + is_recursive_predecessor_of, + is_recursive_predecessor_of_fast, + is_recursive_successor_of_fast, + is_recursive_sucessor_of, + keys, + predecessors, + relate, + session, + successors +

+

Inherited from CCMObject (private): + _getsession +

+

Inherited from FourPartName: + __eq__, + __ne__, + __repr__, + __str__, + family, + instance, + is_same_family, + name, + objectname, + type, + version +

+

Inherited from object: + __delattr__, + __getattribute__, + __hash__, + __new__, + __reduce__, + __reduce_ex__, + __setattr__ +

+
+ + + + + + + + + +
+ + + + + +
Static Methods[hide private]
+
+

Inherited from FourPartName: + convert, + is_valid +

+
+ + + + + + + + + +
+ + + + + +
Class Variables[hide private]
+
+   + + is_query_based = property(lambda x: x.mode.lower()== "query") +
+ + + + + + + + + +
+ + + + + +
Properties[hide private]
+
+

Inherited from object: + __class__ +

+
+ + + + + + +
+ + + + + +
Method Details[hide private]
+
+ +
+ +
+ + +
+

__init__(self, + session, + fpn) +
(Constructor) +

+ 		source code  +
+ +

Create a FourPartName object based on a ifpn string.

+

The string have to match the following patterns: +- name-version:type:instance +- name:version:releasedef:instance +- Task database#id +- Folder database#id

+

Anything else is considered as old release string format.

+
+
Overrides: + CCMObject.__init__ +
+
+
+
+ +
+ +
+ + +
+

copy(self, + existing_folder) +

+ 		source code  +
+ +

Copy the contents of existing_folder into this folder.

+

This appends to the destination folder by default.

+
+
Parameters:
+
    +
  • existing_folder - The destination Folder object.
    • +
+
+
+
+
+ + + + + + + + + + + + + + + +
   Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:17 2009 + + http://epydoc.sourceforge.net +
+ + + + +