Changeset 13135 for main/waeup.ikoba

Timestamp:

3 Jul 2015, 10:24:13 (9 years ago)

Author:

Henrik Bettermann

Message:

Extend interfaces (for future documentation).

Location:

main/waeup.ikoba/trunk/src/waeup/ikoba

Files:

• customers/export.py (modified) (1 diff)
• documents/document.py (modified) (2 diffs)
• documents/export.py (modified) (1 diff)
• documents/interfaces.py (modified) (7 diffs)
• utils/helpers.py (modified) (2 diffs)

main/waeup.ikoba/trunk/src/waeup/ikoba/customers/export.py

@@ -171 +171 @@
                       'translated_class_name',
                       'connected_files',   # Could be used to export file URLs
+                      'form_fields_interface',
+                      'filenames',
+                      'local_roles',
                       ])))
 

main/waeup.ikoba/trunk/src/waeup/ikoba/documents/document.py

@@ -233 +233 @@
     """A file id chooser for :class:`Document` objects.
 
-    `context` is an :class:`Document` instance.
+    `context` is a :class:`Document` instance.
 
     The delivered file_id contains the file id marker for
@@ -267 +267 @@
         *Example:*
 
-        For document with id 'd123'
-        with attr ``'nice_image.jpeg'`` this chooser would create:
-
-          ``'__file-document__nice_image_d123.jpeg'``
+        For document with id ``d123`` and
+        with attr ``nice_image.jpeg`` this chooser would create:
+
+          ``__file-document__nice_image_d123.jpeg``
 
         meaning that the nice image of this document would be

main/waeup.ikoba/trunk/src/waeup/ikoba/documents/export.py

@@ -46 +46 @@
                   'translated_class_name',
                   'connected_files',   # Could be used to export file URLs
+                  'form_fields_interface',
+                  'filenames',
+                  'local_roles',
                   ]
             ))) + (

main/waeup.ikoba/trunk/src/waeup/ikoba/documents/interfaces.py

@@ -26 +26 @@
 class IDocumentsContainer(IIkobaObject):
     """A container for all kind of document objects.
-
     """
 
@@ -36 +35 @@
 class IDocument(IIkobaObject):
     """A base representation of documents.
-
     """
     history = Attribute('Object history, a list of messages')
-    state = Attribute('Returns the verification state of a document')
-    translated_state = Attribute(
-        'Returns a translated, more verbose verification state of a document')
+    state = Attribute('Workflow state of a document')
+    translated_state = Attribute('Translatable workflow state of a document')
     class_name = Attribute('Name of the document class')
-    translated_class_name = Attribute('Translatable class name')
-    formatted_transition_date = Attribute('Last transition formatted date string')
+    translated_class_name = Attribute('Translatable class name of a document')
+    formatted_transition_date = Attribute(
+        'Last transition formatted date string')
+    form_fields_interface = Attribute(
+        'Interface which is used in forms for grok.AutoFields')
+    local_roles = Attribute('List of local role names')
     user_id = Attribute('Id of a user')
     connected_files = Attribute('Names of files connected to a document')
-    is_verifiable = Attribute('Contract verifiable by officer')
+    is_verifiable = Attribute('True if contract verifiable by officer')
 
     document_id = schema.TextLine(
@@ -67 +68 @@
 class IPublicDocument(IDocument):
     """A base representation of public documents.
-
     """
 
@@ -83 +83 @@
 class IPDFDocument(IPublicDocument):
     """A base representation of PDF documents.
-
     """
 
+    filenames = Attribute('Tuple of filenames; only one filename recommended')
 
 class IHTMLDocument(IPublicDocument):
@@ -92 +92 @@
     """
 
-    html_dict = Attribute('Content as language dictionary with values in HTML format')
+    html_dict = Attribute(
+        'Content as language dictionary with values in HTML format')
 
     html_multilingual = schema.Text(
@@ -101 +102 @@
 class IRESTDocument(IPublicDocument):
     """A base representation of REST documents.
-
     """
 
@@ -115 +115 @@
 class IDocumentsUtils(Interface):
     """A collection of methods which are subject to customization.
-
     """
 

main/waeup.ikoba/trunk/src/waeup/ikoba/utils/helpers.py

@@ -811 +811 @@
     """Transforms a localized HTML text string into a dictionary.
 
-    Different languages must be separated by `>>xy<<` whereas
+    Different languages must be separated by ``>>xy<<`` whereas
     xy is the language code. Text parts without correct leading
     language separator - usually the first part has no language
     descriptor - are interpreted as texts in the portal's language.
-    The latter can be configured in waeup.srp.utils.utils.IkobaUtils.
     """
     try:
@@ -838 +837 @@
     """Transforms a localized REST text string into a dictionary.
 
-    Different languages must be separated by `>>xy<<` whereas
+    Different languages must be separated by ``>>xy<<`` whereas
     xy is the language code. Text parts without correct leading
     language separator - usually the first part has no language
     descriptor - are interpreted as texts in the portal's language.
-    The latter can be configured in waeup.srp.utils.utils.IkobaUtils.
     """
     try: