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

Class File

source code

+
+  object --+        
+           |        
+FourPartName --+    
+               |    
+       CCMObject --+
+                   |
+                  File
+
+ +
+Wrapper for any Synergy file object

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Instance Methods[hide private]
+
+   + + + + + + +
__init__(self, + session, + fpn)
+ Create a FourPartName object based on a ifpn string.
+ source code + +
+ +
+   + + + + + + +
content(self) + source code + +
+ +
+   + + + + + + +
to_file(self, + path) + source code + +
+ +
+   + + + + + + +
merge(self, + ccm_object, + task) + source code + +
+ +
+   + + + + + + +
checkin(self, + state, + comment=None) + 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 +

+
+ + + + + + + + + +
+ + + + + +
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__ +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + +
+ + + + +