| 1 | ## $Id: interfaces.py 12225 2014-12-14 09:45:35Z 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 | ## |
|---|
| 18 | from zope.interface import Attribute, Interface |
|---|
| 19 | from zope import schema |
|---|
| 20 | from waeup.ikoba.interfaces import ( |
|---|
| 21 | IIkobaObject, |
|---|
| 22 | ContextualDictSourceFactoryBase) |
|---|
| 23 | from waeup.ikoba.interfaces import MessageFactory as _ |
|---|
| 24 | |
|---|
| 25 | |
|---|
| 26 | class 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 | |
|---|
| 36 | class 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 | |
|---|
| 62 | class 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 | |
|---|
| 73 | |
|---|
| 74 | class IPDFDocument(IPublicDocument): |
|---|
| 75 | """A base representation of PDF documents. |
|---|
| 76 | |
|---|
| 77 | """ |
|---|
| 78 | |
|---|
| 79 | |
|---|
| 80 | class IHTMLDocument(IPublicDocument): |
|---|
| 81 | """A base representation of HTML documents. |
|---|
| 82 | |
|---|
| 83 | """ |
|---|
| 84 | |
|---|
| 85 | |
|---|
| 86 | class IDocumentsUtils(Interface): |
|---|
| 87 | """A collection of methods which are subject to customization. |
|---|
| 88 | |
|---|
| 89 | """ |
|---|
| 90 | |
|---|
