reverting to vendor branch rt 3.0.4, hopefully
[freeside.git] / rt / lib / RT / ScripCondition.pm
index 253502b..fe0aa2d 100755 (executable)
-# Copyright 1999-2000 Jesse Vincent <jesse@fsck.com>
-# Released under the terms of the GNU Public License
-# $Header: /home/cvs/cvsroot/freeside/rt/lib/RT/ScripCondition.pm,v 1.1 2002-08-12 06:17:07 ivan Exp $
+# BEGIN LICENSE BLOCK
+# 
+# Copyright (c) 1996-2003 Jesse Vincent <jesse@bestpractical.com>
+# 
+# (Except where explictly superceded by other copyright notices)
+# 
+# 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
+# Autogenerated by DBIx::SearchBuilder factory (by <jesse@bestpractical.com>)
+# WARNING: THIS FILE IS AUTOGENERATED. ALL CHANGES TO THIS FILE WILL BE LOST.  
+# 
+# !! DO NOT EDIT THIS FILE !!
+#
+
+use strict;
+
 
 =head1 NAME
 
-  RT::ScripCondition - RT scrip conditional
+RT::ScripCondition
+
 
 =head1 SYNOPSIS
 
-  use RT::ScripCondition;
+=head1 DESCRIPTION
 
+=head1 METHODS
 
-=head1 DESCRIPTION
+=cut
 
-This module should never be called directly by client code. it's an internal module which
-should only be accessed through exported APIs in other modules.
+package RT::ScripCondition;
+use RT::Record; 
 
 
-=begin testing
+use vars qw( @ISA );
+@ISA= qw( RT::Record );
 
-ok (require RT::TestHarness);
-ok (require RT::ScripCondition);
+sub _Init {
+  my $self = shift; 
 
-=end testing
+  $self->Table('ScripConditions');
+  $self->SUPER::_Init(@_);
+}
 
-=head1 METHODS
+
+
+
+
+=item Create PARAMHASH
+
+Create takes a hash of values and creates a row in the database:
+
+  varchar(200) 'Name'.
+  varchar(255) 'Description'.
+  varchar(60) 'ExecModule'.
+  varchar(255) 'Argument'.
+  varchar(60) 'ApplicableTransTypes'.
 
 =cut
 
-package RT::ScripCondition;
-use RT::Record;
-@ISA= qw(RT::Record);
-
-# {{{  sub _Init 
-sub _Init  {
-    my $self = shift; 
-    $self->{'table'} = "ScripConditions";
-    return ($self->SUPER::_Init(@_));
-}
-# }}}
 
-# {{{ sub _Accessible 
-sub _Accessible  {
+
+
+sub Create {
     my $self = shift;
-    my %Cols = ( Name  => 'read',
-                Description => 'read',
-                ApplicableTransTypes    => 'read',
-                ExecModule  => 'read',
-                Argument  => 'read',
-                Creator => 'read/auto',
-                Created => 'read/auto',
-                LastUpdatedBy => 'read/auto',
-                LastUpdated => 'read/auto'
-              );
-    return($self->SUPER::_Accessible(@_, %Cols));
+    my %args = ( 
+                Name => '',
+                Description => '',
+                ExecModule => '',
+                Argument => '',
+                ApplicableTransTypes => '',
+
+                 @_);
+    $self->SUPER::Create(
+                         Name => $args{'Name'},
+                         Description => $args{'Description'},
+                         ExecModule => $args{'ExecModule'},
+                         Argument => $args{'Argument'},
+                         ApplicableTransTypes => $args{'ApplicableTransTypes'},
+);
+
 }
-# }}}
 
-# {{{ sub Create 
 
-=head2 Create
-  
-  Takes a hash. Creates a new Condition entry.
-  should be better documented.
+
+=item id
+
+Returns the current value of id. 
+(In the database, id is stored as int(11).)
+
 
 =cut
 
-sub Create  {
-    my $self = shift;
-    return($self->SUPER::Create(@_));
-}
-# }}}
 
-# {{{ sub Delete 
+=item Name
 
-=head2 Delete
+Returns the current value of Name. 
+(In the database, Name is stored as varchar(200).)
+
+
+
+=item SetName VALUE
+
+
+Set Name to VALUE. 
+Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
+(In the database, Name will be stored as a varchar(200).)
 
-No API available for deleting things just yet.
 
 =cut
 
-sub Delete  {
-    my $self = shift;
-    return(0,'Unimplemented');
-}
-# }}}
 
-# {{{ sub Load 
+=item Description
 
-=head2 Load IDENTIFIER
+Returns the current value of Description. 
+(In the database, Description is stored as varchar(255).)
+
+
+
+=item SetDescription VALUE
+
+
+Set Description to VALUE. 
+Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
+(In the database, Description will be stored as a varchar(255).)
 
-Loads a condition takes a name or ScripCondition id.
 
 =cut
 
-sub Load  {
-    my $self = shift;
-    my $identifier = shift;
-    
-    unless (defined $identifier) {
-       return (undef);
-    }      
-    
-    if ($identifier !~ /\D/) {
-       return ($self->SUPER::LoadById($identifier));
-    }
-    else {
-       return ($self->LoadByCol('Name', $identifier));
-    }
-}
-# }}}
 
-# {{{ sub LoadCondition 
+=item ExecModule
+
+Returns the current value of ExecModule. 
+(In the database, ExecModule is stored as varchar(60).)
+
+
+
+=item SetExecModule VALUE
+
 
-=head2 LoadCondition  HASH
+Set ExecModule to VALUE. 
+Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
+(In the database, ExecModule will be stored as a varchar(60).)
 
-takes a hash which has the following elements:  TransactionObj and TicketObj.
-Loads the Condition module in question.
 
 =cut
 
 
-sub LoadCondition  {
-    my $self = shift;
-    my %args = ( TransactionObj => undef,
-                TicketObj => undef,
-                @_ );
-    
-    #TODO: Put this in an eval  
-    $self->ExecModule =~ /^(\w+)$/;
-    my $module = $1;
-    my $type = "RT::Condition::". $module;
-    
-    $RT::Logger->debug("now requiring $type\n"); 
-    eval "require $type" || die "Require of $type failed.\n$@\n";
-    
-    $self->{'Condition'}  = $type->new ( 'ScripConditionObj' => $self, 
-                                        'TicketObj' => $args{'TicketObj'},
-                                        'TransactionObj' => $args{'TransactionObj'},
-                                        'Argument' => $self->Argument,
-                                        'ApplicableTransTypes' => $self->ApplicableTransTypes,
-                                      );
-}
-# }}}
+=item Argument
+
+Returns the current value of Argument. 
+(In the database, Argument is stored as varchar(255).)
 
-# {{{ The following methods call the Condition object
 
 
-# {{{ sub Describe 
+=item SetArgument VALUE
 
-=head2 Describe 
 
-Helper method to call the condition module\'s Describe method.
+Set Argument to VALUE. 
+Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
+(In the database, Argument will be stored as a varchar(255).)
+
 
 =cut
 
-sub Describe  {
-    my $self = shift;
-    return ($self->{'Condition'}->Describe());
-    
-}
-# }}}
 
-# {{{ sub IsApplicable 
+=item ApplicableTransTypes
 
-=head2 IsApplicable
+Returns the current value of ApplicableTransTypes. 
+(In the database, ApplicableTransTypes is stored as varchar(60).)
+
+
+
+=item SetApplicableTransTypes VALUE
+
+
+Set ApplicableTransTypes to VALUE. 
+Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
+(In the database, ApplicableTransTypes will be stored as a varchar(60).)
 
-Helper method to call the condition module\'s IsApplicable method.
 
 =cut
 
-sub IsApplicable  {
-    my $self = shift;
-    return ($self->{'Condition'}->IsApplicable());
-    
-}
-# }}}
 
-# }}}
+=item Creator
 
-# {{{ sub DESTROY
-sub DESTROY {
-    my $self=shift;
-    $self->{'Condition'} = undef;
-}
-# }}}
+Returns the current value of Creator. 
+(In the database, Creator is stored as int(11).)
 
 
-1;
+=cut
+
+
+=item Created
+
+Returns the current value of Created. 
+(In the database, Created is stored as datetime.)
+
+
+=cut
+
+
+=item LastUpdatedBy
+
+Returns the current value of LastUpdatedBy. 
+(In the database, LastUpdatedBy is stored as int(11).)
+
+
+=cut
+
+
+=item LastUpdated
+
+Returns the current value of LastUpdated. 
+(In the database, LastUpdated is stored as datetime.)
 
 
+=cut
+
+
+
+sub _ClassAccessible {
+    {
+     
+        id =>
+               {read => 1, type => 'int(11)', default => ''},
+        Name => 
+               {read => 1, write => 1, type => 'varchar(200)', default => ''},
+        Description => 
+               {read => 1, write => 1, type => 'varchar(255)', default => ''},
+        ExecModule => 
+               {read => 1, write => 1, type => 'varchar(60)', default => ''},
+        Argument => 
+               {read => 1, write => 1, type => 'varchar(255)', default => ''},
+        ApplicableTransTypes => 
+               {read => 1, write => 1, type => 'varchar(60)', default => ''},
+        Creator => 
+               {read => 1, auto => 1, type => 'int(11)', default => '0'},
+        Created => 
+               {read => 1, auto => 1, type => 'datetime', default => ''},
+        LastUpdatedBy => 
+               {read => 1, auto => 1, type => 'int(11)', default => '0'},
+        LastUpdated => 
+               {read => 1, auto => 1, type => 'datetime', default => ''},
+
+ }
+};
+
+
+        eval "require RT::ScripCondition_Overlay";
+        if ($@ && $@ !~ qr{^Can't locate RT/ScripCondition_Overlay.pm}) {
+            die $@;
+        };
+
+        eval "require RT::ScripCondition_Vendor";
+        if ($@ && $@ !~ qr{^Can't locate RT/ScripCondition_Vendor.pm}) {
+            die $@;
+        };
+
+        eval "require RT::ScripCondition_Local";
+        if ($@ && $@ !~ qr{^Can't locate RT/ScripCondition_Local.pm}) {
+            die $@;
+        };
+
+
+
+
+=head1 SEE ALSO
+
+This class allows "overlay" methods to be placed
+into the following files _Overlay is for a System overlay by the original author,
+_Vendor is for 3rd-party vendor add-ons, while _Local is for site-local customizations.  
+
+These overlay files can contain new subs or subs to replace existing subs in this module.
+
+If you'll be working with perl 5.6.0 or greater, each of these files should begin with the line 
+
+   no warnings qw(redefine);
+
+so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
+
+RT::ScripCondition_Overlay, RT::ScripCondition_Vendor, RT::ScripCondition_Local
+
+=cut
+
+
+1;