TimeWorked-like custom fields, RT#11168

[freeside.git] / rt / lib / RT / ScripAction_Overlay.pm

diff --git a/rt/lib/RT/ScripAction_Overlay.pm b/rt/lib/RT/ScripAction_Overlay.pm
index e759871..9ea6772 100644 (file)
--- a/rt/lib/RT/ScripAction_Overlay.pm
+++ b/rt/lib/RT/ScripAction_Overlay.pm
@@ -1,26 +1,51 @@
-# BEGIN LICENSE BLOCK
-# 
-# Copyright (c) 1996-2003 Jesse Vincent <jesse@bestpractical.com>
-# 
-# (Except where explictly superceded by other copyright notices)
-# 
+# BEGIN BPS TAGGED BLOCK {{{
+#
+# COPYRIGHT:
+#
+# This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC
+#                                          <sales@bestpractical.com>
+#
+# (Except where explicitly superseded by other copyright notices)
+#
+#
+# LICENSE:
+#
 # This work is made available to you under the terms of Version 2 of
 # the GNU General Public License. A copy of that license should have
 # been provided with this software, but in any event can be snarfed
 # from www.gnu.org.
-# 
+#
 # This work 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.
-# 
-# Unless otherwise specified, all modifications, corrections or
-# extensions to this work which alter its source code become the
-# property of Best Practical Solutions, LLC when submitted for
-# inclusion in the work.
-# 
-# 
-# END LICENSE BLOCK
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+# 02110-1301 or visit their web page on the internet at
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
+#
+#
+# CONTRIBUTION SUBMISSION POLICY:
+#
+# (The following paragraph is not intended to limit the rights granted
+# to you to modify and distribute this software under the terms of
+# the GNU General Public License and is only of importance to you if
+# you choose to contribute your changes and enhancements to the
+# community by submitting them to Best Practical Solutions, LLC.)
+#
+# By intentionally submitting any modifications, corrections or
+# derivatives to this work, or any other work intended for use with
+# Request Tracker, to Best Practical Solutions, LLC, you confirm that
+# you are the copyright holder for those contributions and you grant
+# Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
+# royalty-free, perpetual, license to use, copy, create derivative
+# works based on those contributions, and sublicense and distribute
+# those contributions and any derivatives thereof.
+#
+# END BPS TAGGED BLOCK }}}
+
 =head1 NAME
 
   RT::ScripAction - RT Action object
@@ -36,28 +61,18 @@ This module should never be called directly by client code. it's an internal mod
 should only be accessed through exported APIs in other modules.
 
 
-=begin testing
-
-ok (require RT::ScripAction);
-
-=end testing
 
 =head1 METHODS
 
 =cut
 
+
+package RT::ScripAction;
+
 use strict;
 no warnings qw(redefine);
 use RT::Template;
 
-# {{{  sub _Init 
-sub _Init  {
-    my $self = shift; 
-    $self->{'table'} = "ScripActions";
-    return ($self->SUPER::_Init(@_));
-}
-# }}}
-
 # {{{ sub _Accessible 
 sub _Accessible  {
     my $self = shift;
@@ -75,10 +90,12 @@ sub _Accessible  {
 # }}}
 
 # {{{ sub Create 
+
 =head2 Create
-  
- Takes a hash. Creates a new Action entry.
- should be better documented.
+
+Takes a hash. Creates a new Action entry.  should be better
+documented.
+
 =cut
 
 sub Create  {
@@ -97,6 +114,15 @@ sub Delete  {
 # }}}
 
 # {{{ sub Load 
+
+=head2 Load IDENTIFIER
+
+Loads an action by its Name.
+
+Returns: Id, Error Message
+
+=cut
+
 sub Load  {
     my $self = shift;
     my $identifier = shift;
@@ -119,7 +145,7 @@ sub Load  {
        
        $self->{'Template'} = $template;
     }
-    return ($self->loc('[_1] ScripAction loaded', $self->Id));
+    return ($self->Id, ($self->loc('[_1] ScripAction loaded', $self->Id)));
 }
 # }}}
 
@@ -146,12 +172,13 @@ sub LoadAction  {
  
     eval "require $type" || die "Require of $type failed.\n$@\n";
     
-    $self->{'Action'}  = $type->new ( 'ScripActionObj' => $self, 
-                                     'TicketObj' => $args{'TicketObj'},
-                                     'ScripObj' => $args{'ScripObj'},
-                                     'TransactionObj' => $args{'TransactionObj'},
-                                     'TemplateObj' => $self->TemplateObj,
-                                     'Argument' => $self->Argument,
+    $self->{'Action'}  = $type->new ( Argument => $self->Argument,
+                                      CurrentUser => $self->CurrentUser,
+                                      ScripActionObj => $self, 
+                                      ScripObj => $args{'ScripObj'},
+                                      TemplateObj => $self->TemplateObj,
+                                      TicketObj => $args{'TicketObj'},
+                                      TransactionObj => $args{'TransactionObj'},
                                    );
 }
 # }}}
@@ -160,7 +187,10 @@ sub LoadAction  {
 
 =head2 TemplateObj
 
-Return this action\'s template object
+Return this action's template object
+
+TODO: Why are we not using the Scrip's template object?
+
 
 =cut
 
@@ -196,7 +226,8 @@ sub TemplateObj {
 
 sub Prepare  {
     my $self = shift;
-    return ($self->{'Action'}->Prepare());
+    $self->{_Message_ID} = 0;
+    return ($self->Action->Prepare());
   
 }
 # }}}
@@ -204,7 +235,7 @@ sub Prepare  {
 # {{{ sub Commit 
 sub Commit  {
     my $self = shift;
-    return($self->{'Action'}->Commit());
+    return($self->Action->Commit());
     
     
 }
@@ -213,11 +244,22 @@ sub Commit  {
 # {{{ sub Describe 
 sub Describe  {
     my $self = shift;
-    return ($self->{'Action'}->Describe());
+    return ($self->Action->Describe());
     
 }
 # }}}
 
+=head2 Action
+
+Return the actual RT::Action object for this scrip.
+
+=cut
+
+sub Action {
+    my $self = shift;
+    return ($self->{'Action'});
+}
+
 # {{{ sub DESTROY
 sub DESTROY {
     my $self=shift;
@@ -227,6 +269,12 @@ sub DESTROY {
 }
 # }}}
 
+=head2 TODO
+
+Between this, RT::Scrip and RT::Action::*, we need to be able to get rid of a 
+class. This just reeks of too much complexity -- jesse
+
+=cut
 
 1;