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

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

We need documents which can be accessed or downloaded from product pages. These documents can provide general information of registration processes or pdf forms to be filled offline and later uploaded by customers.

  • Property svn:keywords set to Id
File size: 2.5 KB
Line 
1## $Id: interfaces.py 12200 2014-12-12 15:34:50Z 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    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    title = schema.TextLine(
52        title = _(u'Document Title'),
53        required = True,
54        )
55
56    last_transition_date = schema.Datetime(
57        title = _(u'Last Transition Date'),
58        required = False,
59        readonly = False,
60        )
61
62    def setMD5():
63        """Determine md5 checksum of selected files and store checksums as
64        document attributes.
65        """
66
67class IPDFDocument(IDocument):
68    """A base representation of PDF documents.
69
70    """
71
72
73class IHTMLDocument(IDocument):
74    """A base representation of HTML documents.
75
76    """
77
78
79class IDocumentsUtils(Interface):
80    """A collection of methods which are subject to customization.
81
82    """
83
Note: See TracBrowser for help on using the repository browser.