[CMF-checkins] CVS: Products/CMFDefault - Document.py:1.69.2.6

Thu May 26 11:28:16 EDT 2005

Update of /cvs-repository/Products/CMFDefault
In directory cvs.zope.org:/tmp/cvs-serv14712/CMFDefault

Modified Files:
      Tag: CMF-1_5-branch
	Document.py 
Log Message:
added document interfaces (based on CMFonFive code)


=== Products/CMFDefault/Document.py 1.69.2.5 => 1.69.2.6 ===

--- Products/CMFDefault/Document.py:1.69.2.5	Tue Apr  5 05:25:20 2005
+++ Products/CMFDefault/Document.py	Thu May 26 11:27:35 2005
@@ -35,6 +35,8 @@
 from DublinCore import DefaultDublinCoreImpl
 from exceptions import EditingConflict
 from exceptions import ResourceLockedError
+from interfaces.Document import IDocument
+from interfaces.Document import IMutableDocument
 from permissions import ModifyPortalContent
 from permissions import View
 from utils import _dtmldir
@@ -88,9 +90,9 @@
 class Document(PortalContent, DefaultDublinCoreImpl):
     """ A Document - Handles both StructuredText and HTML """
 
-    __implements__ = ( PortalContent.__implements__
-                     , DefaultDublinCoreImpl.__implements__
-                     )
+    __implements__ = (IDocument, IMutableDocument,
+                      PortalContent.__implements__,
+                      DefaultDublinCoreImpl.__implements__)
 
     meta_type = 'Document'
     effective_date = expiration_date = None
@@ -151,14 +153,14 @@
         else:
             self.cooked_text = HTML(text, level=self._stx_level, header=0)
 
+    #
+    #   IMutableDocument method
+    #
+
     security.declareProtected(ModifyPortalContent, 'edit')
-    def edit( self
-            , text_format
-            , text
-            , file=''
-            , safety_belt=''
-            ):
-        """
+    def edit(self, text_format, text, file='', safety_belt=''):
+        """ Update the document.
+
         To add webDav support, we need to check if the content is locked, and if
         so return ResourceLockedError if not, call _edit.
 
@@ -277,6 +279,11 @@
         return 1
 
     ### Content accessor methods
+
+    #
+    #   IContentish method
+    #
+
     security.declareProtected(View, 'SearchableText')
     def SearchableText(self):
         """ Used by the catalog for basic full text indexing """
@@ -285,9 +292,14 @@
                             , self.EditableBody()
                             )
 
+    #
+    #   IDocument methods
+    #
+
     security.declareProtected(View, 'CookedBody')
     def CookedBody(self, stx_level=None, setlevel=0):
-        """\
+        """ Get the "cooked" (ready for presentation) form of the text.
+
         The prepared basic rendering of an object.  For Documents, this
         means pre-rendered structured text, or what was between the
         <BODY> tags of HTML.
@@ -310,12 +322,17 @@
 
     security.declareProtected(View, 'EditableBody')
     def EditableBody(self):
-        """\
+        """ Get the "raw" (as edited) form of the text.
+
         The editable body of text.  This is the raw structured text, or
         in the case of HTML, what was between the <BODY> tags.
         """
         return self.text
 
+    #
+    #   IDublinCore method
+    #
+
     security.declareProtected(View, 'Format')
     def Format(self):
         """ Dublin Core Format element - resource format.
@@ -325,6 +342,10 @@
         else:
             return 'text/plain'
 
+    #
+    #   IMutableDublinCore method
+    #
+
     security.declareProtected(ModifyPortalContent, 'setFormat')
     def setFormat(self, format):
         """ Set text format and Dublin Core resource format.
@@ -354,7 +375,6 @@
 
     ## FTP handlers
     security.declareProtected(ModifyPortalContent, 'PUT')
-
     def PUT(self, REQUEST, RESPONSE):
         """ Handle HTTP (and presumably FTP?) PUT requests """
         self.dav__init(REQUEST, RESPONSE)

