source: main/waeup.ikoba/trunk/src/waeup/ikoba/documents/interfaces.py @ 12237

Last change on this file since 12237 was 12227, checked in by Henrik Bettermann, 10 years ago

Setup html documents. This technique replaces the usage of the HTMLDisplayWidget.

  • Property svn:keywords set to Id
File size: 2.9 KB
Line 
1## $Id: interfaces.py 12227 2014-12-14 14:59:41Z henrik $
2##
3## Copyright (C) 2014 Uli Fouquet & Henrik Bettermann
4## This program is free software; you can redistribute it and/or modify
5## it under the terms of the GNU General Public License as published by
6## the Free Software Foundation; either version 2 of the License, or
7## (at your option) any later version.
8##
9## This program is distributed in the hope that it will be useful,
10## but WITHOUT ANY WARRANTY; without even the implied warranty of
11## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12## GNU General Public License for more details.
13##
14## You should have received a copy of the GNU General Public License
15## along with this program; if not, write to the Free Software
16## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17##
18from zope.interface import Attribute, Interface
19from zope import schema
20from waeup.ikoba.interfaces import (
21    IIkobaObject,
22    ContextualDictSourceFactoryBase)
23from waeup.ikoba.interfaces import MessageFactory as _
24
25
26class IDocumentsContainer(IIkobaObject):
27    """A container for all kind of document objects.
28
29    """
30
31    def addDocument(document):
32        """Add a document.
33        """
34
35
36class IDocument(IIkobaObject):
37    """A base representation of documents.
38
39    """
40    document_id = Attribute('Document Identifier')
41    history = Attribute('Object history, a list of messages')
42    state = Attribute('Returns the verification state of a document')
43    translated_state = Attribute(
44        'Returns a translated, more verbose verification state of a document')
45    class_name = Attribute('Name of the document class')
46    translated_class_name = Attribute('Translatable class name')
47    formatted_transition_date = Attribute('Last transition formatted date string')
48    user_id = Attribute('Id of a user')
49    connected_files = Attribute('Names of files connected to a document')
50    is_verifiable = Attribute('Contract verifiable by officer')
51
52    title = schema.TextLine(
53        title = _(u'Document Title'),
54        required = True,
55        )
56
57    def setMD5():
58        """Determine md5 checksum of selected files and store checksums as
59        document attributes.
60        """
61
62class IPublicDocument(IDocument):
63    """A base representation of public documents.
64
65    """
66
67    def writeLogMessage(view, message):
68        """Write a view specific log message into main.log.
69
70        """
71
72    description = schema.Text(
73        title = _(u'Description'),
74        required = False,
75        )
76
77
78class IPDFDocument(IPublicDocument):
79    """A base representation of PDF documents.
80
81    """
82
83
84class IHTMLDocument(IPublicDocument):
85    """A base representation of HTML documents.
86
87    """
88
89    html_dict = Attribute('Content as language dictionary with values in html format')
90
91    html_multilang = schema.Text(
92        title = _(u'Content in HTML format'),
93        required = False,
94        )
95
96
97class IDocumentsUtils(Interface):
98    """A collection of methods which are subject to customization.
99
100    """
101
Note: See TracBrowser for help on using the repository browser.