GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  WORKFLOW::PERSISTER::SPOPS (3)

.ds Aq ’

NAME

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

CONTENTS

VERSION

This documentation describes version 1.07 of this package

SYNOPSIS



 <persister name="SPOPSPersister"
            class="Workflow::Persister::SPOPS"
            workflow_class="My::Persist::Workflow"
            history_class="My::Persist::History"/>



DESCRIPTION

    Overview

Use a SPOPS classes to persist your workflow and workflow history information. Configuration is simple: just specify the class names and everything else is done.

We do not perform any class initialization, so somewhere in your server/process startup code you should have something like:



 my $config = get_workflow_and_history_config();
 SPOPS::Initialize->process({ config => $config });



This will generate the classes named in the persister configuration.

    SPOPS Configuration

<B>NOTEB>: The configuration for your workflow history object <B>mustB> use the SPOPS::Tool::DateConvert to translate the ’history_date’ field into a DateTime object. We assume when we fetch the history object that this has already been done.

    METHODS

init ( \%params)

This method initializes the SPOPS persistance entity.

It requires that a workflow_class and a history_class are specified. If not the case Workflow::Exceptions are thrown.

create_workflow

Serializes a workflow into the persistance entity configured by our workflow.

Takes a single parameter: a workflow object

Returns a single value, a id for unique identification of out serialized workflow for possible deserialization.

fetch_workflow

Deserializes a workflow from the persistance entity configured by our workflow.

Takes a single parameter: the unique id assigned to our workflow upon serialization (see create_workflow).

Returns a hashref consisting of two keys:
o state, the workflows current state
o last_update, date indicating last update
update_workflow

Updates a serialized workflow in the persistance entity configured by our workflow.

Takes a single parameter: a workflow object

Returns: Nothing

create_history

Serializes history records associated with a workflow object

Takes two parameters: a workflow object and an array of workflow history objects

Returns: provided array of workflow history objects upon success

fetch_history

Deserializes history records associated with a workflow object

Takes a single parameter: a workflow object

Returns an array of workflow history objects upon success

SEE ALSO

Workflow::Persister

SPOPS

SPOPS::Tool::DateConvert

COPYRIGHT

Copyright (c) 2003-2007 Chris Winters. All rights reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

AUTHORS

Jonas B. Nielsen (jonasbn) <jonasbn@cpan.org> is the current maintainer.

Chris Winters <chris@cwinters.com>, original author.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 WORKFLOW::PERSISTER::SPOPS (3) 2016-04-03

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.