blob: bf213895971c88950757c71ba9e9c48e06b30e0a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
# Copyright (C) 2015-2016 by the Free Software Foundation, Inc.
#
# This file is part of GNU Mailman.
#
# GNU Mailman is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free
# Software Foundation, either version 3 of the License, or (at your option)
# any later version.
#
# GNU Mailman is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
# more details.
#
# You should have received a copy of the GNU General Public License along with
# GNU Mailman. If not, see <http://www.gnu.org/licenses/>.
"""Interfaces describing the state of a workflow."""
from mailman import public
from zope.interface import Attribute, Interface
@public
class IWorkflowState(Interface):
"""The state of a workflow."""
name = Attribute('The name of the workflow.')
token = Attribute('A unique key identifying the workflow instance.')
step = Attribute("This workflow's next step.")
data = Attribute('Additional data (may be JSON-encoded).')
@public
class IWorkflowStateManager(Interface):
"""The workflow states manager."""
def save(name, token, step, data=None):
"""Save the state of a workflow.
:param name: The name of the workflow.
:type name: str
:param token: A unique token identifying this workflow instance.
:type token: str
:param step: The next step for this workflow.
:type step: str
:param data: Additional data (workflow-specific).
:type data: str
"""
def restore(name, token):
"""Get the saved state for a workflow or None if nothing was saved.
:param name: The name of the workflow.
:type name: str
:param token: A unique token identifying this workflow instance.
:type token: str
:return: The saved state associated with this name/token pair, or None
if the pair isn't in the database.
:rtype: ``IWorkflowState``
"""
def discard(name, token):
"""Throw away the saved state for a workflow.
:param name: The name of the workflow.
:type name: str
:param token: A unique token identifying this workflow instance.
:type token: str
"""
count = Attribute('The number of saved workflows in the database.')
|
