getting a little closer

lib/WebGUI/Workflow/Cron.pm

@@ -96,7 +96,7 @@ sub DESTROY {
 
 =head2 get ( name ) 
 
-Returns the value for a given property.
+Returns the value for a given property. See the set() method for details.
 
 =cut
 
@@ -241,9 +241,9 @@ sub set {
 	$self->{_data}{parameters} = (exists $properties->{parameters}) ? $properties->{parameters} : $self->{_data}{parameters};
 	$self->{_data}{enabled} = 0 unless ($self->get("workflowId"));
 	my $spectre = WebGUI::Workflow::Spectre->new($self->session);
-	$spectre->notify("cron/deleteJob",$self->getId);
-	$spectre->notify("cron/addJob",$self->session->config->getFilename, $self->getId);
 	$self->session->db->setRow("WorkflowSchedule","taskId",$self->{_data});
+	$spectre->notify("cron/deleteJob",$self->getId);
+	$spectre->notify("cron/addJob",$self->session->config->getFilename, $self->{_data});
 }
 
 

lib/WebGUI/Workflow/Instance.pm

@@ -0,0 +1,254 @@
+package WebGUI::Workflow::Instance;
+
+
+=head1 LEGAL
+
+ -------------------------------------------------------------------
+  WebGUI is Copyright 2001-2006 Plain Black Corporation.
+ -------------------------------------------------------------------
+  Please read the legal notices (docs/legal.txt) and the license
+  (docs/license.txt) that came with this distribution before using
+  this software.
+ -------------------------------------------------------------------
+  http://www.plainblack.com                     info@plainblack.com
+ -------------------------------------------------------------------
+
+=cut
+
+use strict;
+use WebGUI::Workflow::Spectre;
+
+
+=head1 NAME
+
+Package WebGUI::Workflow::Instance
+
+=head1 DESCRIPTION
+
+This package provides an API for controlling Spectre/Workflow running instances.
+
+=head1 SYNOPSIS
+
+ use WebGUI::Workflow::Instance
+
+=head1 METHODS
+
+These methods are available from this class:
+
+=cut
+
+#-------------------------------------------------------------------
+
+=head2 create ( session, properties ) 
+
+Creates a new workflow instance.
+
+=head3 session
+
+A reference to the current session.
+
+=head3 properties
+
+The settable properties of the workflow instance. See the set() method for details.
+
+=cut
+
+sub create {
+	my $class = shift;
+	my $session = shift;
+	my $properties = shift;
+	my $instanceId = $session->db->setRow("WorkflowInstance","instanceId",{instanceId=>"new", runningSince=>time()});
+	my $self = $class->new($session, $instanceId);
+	$self->set($properties);
+	return $self;
+}
+
+#-------------------------------------------------------------------
+
+=head2 delete ( )
+
+Removes this instance.
+
+=cut
+
+sub delete {
+	my $self = shift;
+	$self->session->db->deleteRow("WorkflowInstance","instanceId",$self->getId);
+	WebGUI::Workflow::Spectre->new($self->session)->notify("workflow/deleteJob",$self->getId);
+	undef $self;
+}
+
+#-------------------------------------------------------------------
+
+=head2 DESTROY ( )
+
+Deconstructor.
+
+=cut
+
+sub DESTROY {
+        my $self = shift;
+        undef $self;
+}
+
+
+#-------------------------------------------------------------------
+
+=head2 get ( name ) 
+
+Returns the value for a given property. See the set() method for details.
+
+=cut
+
+sub get {
+	my $self = shift;
+	return $self->{_data}{shift};
+}
+
+#-------------------------------------------------------------------
+
+=head2 getId ( )
+
+Returns the ID of this instance.
+
+=cut
+
+sub getId {
+	my $self = shift;
+	return $self->{_id};
+}
+
+#-------------------------------------------------------------------
+
+=head2 new ( session, instanceId )
+
+Constructor.
+
+=head3 session
+
+A reference to the current session.
+
+=head3 instanceId 
+
+A unique id refering to a workflow instance.
+
+=cut
+
+sub new {
+	my $class = shift;
+	my $session = shift;
+	my $instanceId = shift;
+	my $data = $session->db->getRow("WorkflowInstance","instanceId", $instanceId);
+	return undef unless $data->{instanceId};
+	bless {_session=>$session, _id=>$instanceId, _data=>$data}, $class;
+}
+
+#-------------------------------------------------------------------
+
+=head2 run ( ) 
+
+Executes the next iteration in this workflow. Returns a status code based upon what happens. The following are the status codes:
+
+ undefined	The workflow doesn't exist.
+ disabled	The workflow is disabled.
+ complete	Workflow has completely run it's course.
+ error		Something bad happened. Try again later.
+
+=cut
+
+sub run {
+	my $self = shift;
+	my $workflow = WebGUI::Workflow->new($self->session, $self->get("workflowId"));
+	return "undefined" unless (defined $workflow);
+	return "disabled" unless ($workflow->get("enabled"));
+	my $activity = $workflow->getNextActivity($self->get("currentActivity"));
+	return "complete" unless (defined $activity);
+	my $object = {};
+	my $class = $self->get("className");
+	my $method = $self->get("method");
+	my $params = $self->get("params");
+	if ($class && $method) {
+		$params = eval($params);
+		if ($@) {
+			$self->session->errorHandler->warn("Error reconsituting activity (".$activity->getId.") pass-in params: ".$@);
+			return "error";
+		}
+		$object = eval($class->$method($self->session, $params));
+		if ($@) {
+			$self->session->errorHandler->warn("Error instanciating  activity (".$activity->getId.") pass-in object: ".$@);
+			return "error";
+		}
+	}
+	$activity->execute($object);	
+}
+
+
+#-------------------------------------------------------------------
+
+=head2 session ( ) 
+
+Returns a reference to the current session.
+
+=cut
+
+sub session {
+	my $self = shift;
+	return $self->{_session};
+}
+
+#-------------------------------------------------------------------
+
+=head2 set ( properties )
+
+Sets one or more of the properties of this workflow instance.
+
+=head3 properties
+
+A hash reference containing properties to change.
+
+=head4 priority
+
+An integer of 1, 2, or 3, with 1 being highest priority (run first) and 3 being lowest priority (run last). Defaults to 2.
+
+=head4 workflowId
+
+The id of the workflow we're executing.
+
+=head4 className
+
+The classname of an object that will be created to pass into the workflow.
+
+=head4 method
+
+The method name of the constructor for className.
+
+=head4 parameters
+
+The parameters to be passed into the constructor. Note that the system will always pass in the session as the first argument.
+
+=head4 currentActivityId
+
+The unique id of the activity in the workflow that needs to be executed next. If blank, it will execute the first activity in the workflow.
+
+=cut
+
+sub set {
+	my $self = shift;
+	my $properties = shift;
+	$self->{_data}{priority} = $properties->{priority} || $self->{_data}{priority} || 2;
+	$self->{_data}{workflowId} = $properties->{workflowId} || $self->{_data}{workflowId};
+	$self->{_data}{className} = (exists $properties->{className}) ? $properties->{className} : $self->{_data}{className};
+	$self->{_data}{method} = (exists $properties->{method}) ? $properties->{method} : $self->{_data}{method};
+	$self->{_data}{parameters} = (exists $properties->{parameters}) ? $properties->{parameters} : $self->{_data}{parameters};
+	$self->{_data}{currentActivityId} = (exists $properties->{currentActivityId}) ? $properties->{currentActivityId} : $self->{_data}{currentActivityId};
+	$self->{_data}{lastUpdate} = time();
+	$self->session->db->setRow("WorkflowInstance","instanceId",$self->{_data});
+	my $spectre = WebGUI::Workflow::Spectre->new($self->session);
+	$spectre->notify("workflow/deleteJob",$self->getId);
+	$spectre->notify("workflow/addJob",$self->session->config->getFilename, $self->{_data});
+}
+
+
+1;
+
+