1Workflow::Persister::SPUOsPeSr(3C)ontributed Perl DocumeWnotraktfiloonw::Persister::SPOPS(3)
2
3
4

NAME

6       Workflow::Persister::SPOPS - Persist workflows using SPOPS
7

VERSION

9       This documentation describes version 1.61 of this package
10

SYNOPSIS

12        <persister name="SPOPSPersister"
13                   class="Workflow::Persister::SPOPS"
14                   workflow_class="My::Persist::Workflow"
15                   history_class="My::Persist::History"/>
16

DESCRIPTION

18   Overview
19       Use a SPOPS classes to persist your workflow and workflow history
20       information. Configuration is simple: just specify the class names and
21       everything else is done.
22
23       We do not perform any class initialization, so somewhere in your
24       server/process startup code you should have something like:
25
26        my $config = get_workflow_and_history_config();
27        SPOPS::Initialize->process({ config => $config });
28
29       This will generate the classes named in the persister configuration.
30
31   SPOPS Configuration
32       NOTE: The configuration for your workflow history object must use the
33       SPOPS::Tool::DateConvert to translate the 'history_date' field into a
34       DateTime object. We assume when we fetch the history object that this
35       has already been done.
36
37   METHODS
38       init ( \%params)
39
40       This method initializes the SPOPS persistance entity.
41
42       It requires that a workflow_class and a history_class are specified. If
43       not the case Workflow::Exceptions are thrown.
44
45       create_workflow
46
47       Serializes a workflow into the persistance entity configured by our
48       workflow.
49
50       Takes a single parameter: a workflow object
51
52       Returns a single value, a id for unique identification of out
53       serialized workflow for possible deserialization.
54
55       fetch_workflow
56
57       Deserializes a workflow from the persistance entity configured by our
58       workflow.
59
60       Takes a single parameter: the unique id assigned to our workflow upon
61       serialization (see "create_workflow").
62
63       Returns a hashref consisting of two keys:
64
65       •   state, the workflows current state
66
67       •   last_update, date indicating last update
68
69       update_workflow
70
71       Updates a serialized workflow in the persistance entity configured by
72       our workflow.
73
74       Takes a single parameter: a workflow object
75
76       Returns: Nothing
77
78       create_history
79
80       Serializes history records associated with a workflow object
81
82       Takes two parameters: a workflow object and an array of workflow
83       history objects
84
85       Returns: provided array of workflow history objects upon success
86
87       fetch_history
88
89       Deserializes history records associated with a workflow object
90
91       Takes a single parameter: a workflow object
92
93       Returns an array of workflow history objects upon success
94

SEE ALSO

96       •   Workflow::Persister
97
98       •   SPOPS
99
100       •   SPOPS::Tool::DateConvert
101

103       Copyright (c) 2003-2022 Chris Winters. All rights reserved.
104
105       This library is free software; you can redistribute it and/or modify it
106       under the same terms as Perl itself.
107
108       Please see the LICENSE
109

AUTHORS

111       Please see Workflow
112
113
114
115perl v5.36.0                      2023-01-20     Workflow::Persister::SPOPS(3)
Impressum