source: main/waeup.kofa/trunk/src/waeup/kofa/documents/interfaces.py @ 12891

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

Propset svn:keywords "Id"

  • Property svn:keywords set to Id
File size: 3.3 KB
Line 
1## $Id: interfaces.py 12438 2015-01-11 08:27:37Z 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.kofa.interfaces import (
21    IKofaObject, validate_id,
22    ContextualDictSourceFactoryBase)
23from waeup.kofa.interfaces import MessageFactory as _
24
25
26class IDocumentsContainer(IKofaObject):
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(IKofaObject):
37    """A base representation of documents.
38
39    """
40    history = Attribute('Object history, a list of messages')
41    state = Attribute('Returns the verification state of a document')
42    translated_state = Attribute(
43        'Returns a translated, more verbose verification state of a document')
44    class_name = Attribute('Name of the document class')
45    translated_class_name = Attribute('Translatable class name')
46    formatted_transition_date = Attribute('Last transition formatted date string')
47    user_id = Attribute('Id of a user')
48    connected_files = Attribute('Names of files connected to a document')
49    is_verifiable = Attribute('Contract verifiable by officer')
50
51    document_id = schema.TextLine(
52        title = _(u'Document Id'),
53        required = True,
54        constraint=validate_id,
55        )
56
57    title = schema.TextLine(
58        title = _(u'Document Title'),
59        required = True,
60        )
61
62    def setMD5():
63        """Determine md5 checksum of selected files and store checksums as
64        document attributes.
65        """
66
67class IPublicDocument(IDocument):
68    """A base representation of public documents.
69
70    """
71
72    def writeLogMessage(view, message):
73        """Write a view specific log message into main.log.
74
75        """
76
77class IPDFDocument(IPublicDocument):
78    """A base representation of PDF documents.
79
80    """
81
82
83class IHTMLDocument(IPublicDocument):
84    """A base representation of HTML documents.
85
86    """
87
88    html_dict = Attribute('Content as language dictionary with values in HTML format')
89
90    html_multilingual = schema.Text(
91        title = _(u'Multilingual content in HTML format'),
92        required = False,
93        )
94
95class IRESTDocument(IPublicDocument):
96    """A base representation of REST documents.
97
98    """
99
100    html_dict = Attribute(
101        'Content as language dictionary with values in HTML format')
102
103    rest_multilingual = schema.Text(
104        title = _(u'Multilingual content in REST (reStructuredText) format'),
105        required = False,
106        )
107
108
109class IDocumentsUtils(Interface):
110    """A collection of methods which are subject to customization.
111
112    """
113
Note: See TracBrowser for help on using the repository browser.