X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;ds=sidebyside;f=rt%2Flib%2FRT%2FScripAction.pm;h=643977be76fb883a3720e1fe665ce1a7438b8983;hb=8103c1fc1b2c27a6855feadf26f91b980a54bc52;hp=471ad9191bb76bbfe116720aad41a5b532d2ed95;hpb=3ef62a0570055da710328937e7f65dbb2c027c62;p=freeside.git diff --git a/rt/lib/RT/ScripAction.pm b/rt/lib/RT/ScripAction.pm index 471ad9191..643977be7 100755 --- a/rt/lib/RT/ScripAction.pm +++ b/rt/lib/RT/ScripAction.pm @@ -1,200 +1,303 @@ -# Copyright 1999-2000 Jesse Vincent -# Released under the terms of the GNU Public License -# $Header: /home/cvs/cvsroot/freeside/rt/lib/RT/ScripAction.pm,v 1.1 2002-08-12 06:17:07 ivan Exp $ +# BEGIN BPS TAGGED BLOCK {{{ +# +# COPYRIGHT: +# +# This software is Copyright (c) 1996-2007 Best Practical Solutions, LLC +# +# +# (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. +# +# 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/copyleft/gpl.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 }}} +# Autogenerated by DBIx::SearchBuilder factory (by ) +# WARNING: THIS FILE IS AUTOGENERATED. ALL CHANGES TO THIS FILE WILL BE LOST. +# +# !! DO NOT EDIT THIS FILE !! +# + +use strict; + =head1 NAME - RT::ScripAction - RT Action object +RT::ScripAction + =head1 SYNOPSIS - use RT::ScripAction; +=head1 DESCRIPTION +=head1 METHODS + +=cut + +package RT::ScripAction; +use RT::Record; -=head1 DESCRIPTION -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. +use vars qw( @ISA ); +@ISA= qw( RT::Record ); +sub _Init { + my $self = shift; -=begin testing + $self->Table('ScripActions'); + $self->SUPER::_Init(@_); +} -ok (require RT::TestHarness); -ok (require RT::ScripAction); -=end testing -=head1 METHODS + + +=head2 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'. =cut -package RT::ScripAction; -use RT::Record; -@ISA= qw(RT::Record); - -# {{{ sub _Init -sub _Init { - my $self = shift; - $self->{'table'} = "ScripActions"; - return ($self->SUPER::_Init(@_)); -} -# }}} -# {{{ sub _Accessible -sub _Accessible { + + +sub Create { my $self = shift; - my %Cols = ( Name => 'read', - Description => '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 => '', + + @_); + $self->SUPER::Create( + Name => $args{'Name'}, + Description => $args{'Description'}, + ExecModule => $args{'ExecModule'}, + Argument => $args{'Argument'}, +); + } -# }}} -# {{{ sub Create -=head2 Create - - Takes a hash. Creates a new Action entry. - should be better documented. + + +=head2 id + +Returns the current value of id. +(In the database, id is stored as int(11).) + + =cut -sub Create { - my $self = shift; - #TODO check these args and do smart things. - return($self->SUPER::Create(@_)); -} -# }}} -# {{{ sub Delete -sub Delete { - my $self = shift; - - return (0, "ScripAction->Delete not implemented"); -} -# }}} +=head2 Name + +Returns the current value of Name. +(In the database, Name is stored as varchar(200).) -# {{{ sub Load -sub Load { - my $self = shift; - my $identifier = shift; - - if (!$identifier) { - return (0, 'Input error'); - } - - if ($identifier !~ /\D/) { - $self->SUPER::LoadById($identifier); - } - else { - $self->LoadByCol('Name', $identifier); - - } - - if (@_) { - # Set the template Id to the passed in template - my $template = shift; - - $self->{'Template'} = $template; - } - return ($self->Id, 'ScripAction loaded'); -} -# }}} -# {{{ sub LoadAction -=head2 LoadAction HASH +=head2 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).) - Takes a hash consisting of TicketObj and TransactionObj. Loads an RT::Action:: module. =cut -sub LoadAction { - my $self = shift; - my %args = ( TransactionObj => undef, - TicketObj => undef, - @_ ); - - #TODO: Put this in an eval - $self->ExecModule =~ /^(\w+)$/; - my $module = $1; - my $type = "RT::Action::". $module; - - $RT::Logger->debug("now requiring $type\n"); - eval "require $type" || die "Require of $type failed.\n$@\n"; - - $self->{'Action'} = $type->new ( 'ScripActionObj' => $self, - 'TicketObj' => $args{'TicketObj'}, - 'TransactionObj' => $args{'TransactionObj'}, - 'TemplateObj' => $self->TemplateObj, - 'Argument' => $self->Argument, - ); -} -# }}} -# {{{ sub TemplateObj +=head2 Description + +Returns the current value of Description. +(In the database, Description is stored as varchar(255).) + + -=head2 TemplateObj +=head2 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).) -Return this action\'s template object =cut -sub TemplateObj { - my $self = shift; - return undef unless $self->{Template}; - if (!$self->{'TemplateObj'}) { - require RT::Template; - $self->{'TemplateObj'} = RT::Template->new($self->CurrentUser); - $self->{'TemplateObj'}->LoadById($self->{'Template'}); - - } - - return ($self->{'TemplateObj'}); -} -# }}} -# The following methods call the action object +=head2 ExecModule -# {{{ sub Prepare +Returns the current value of ExecModule. +(In the database, ExecModule is stored as varchar(60).) -sub Prepare { - my $self = shift; - return ($self->{'Action'}->Prepare()); - -} -# }}} -# {{{ sub Commit -sub Commit { - my $self = shift; - return($self->{'Action'}->Commit()); - - -} -# }}} -# {{{ sub Describe -sub Describe { - my $self = shift; - return ($self->{'Action'}->Describe()); - -} -# }}} +=head2 SetExecModule VALUE -# {{{ sub DESTROY -sub DESTROY { - my $self=shift; - $self->{'Action'} = undef; - $self->{'TemplateObj'} = undef; -} -# }}} +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).) -1; +=cut + + +=head2 Argument + +Returns the current value of Argument. +(In the database, Argument is stored as varchar(255).) + + +=head2 SetArgument VALUE + + +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 + + +=head2 Creator + +Returns the current value of Creator. +(In the database, Creator is stored as int(11).) + + +=cut + + +=head2 Created + +Returns the current value of Created. +(In the database, Created is stored as datetime.) + + +=cut + + +=head2 LastUpdatedBy + +Returns the current value of LastUpdatedBy. +(In the database, LastUpdatedBy is stored as int(11).) + + +=cut + + +=head2 LastUpdated + +Returns the current value of LastUpdated. +(In the database, LastUpdated is stored as datetime.) + + +=cut + + + +sub _CoreAccessible { + { + + id => + {read => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => ''}, + Name => + {read => 1, write => 1, sql_type => 12, length => 200, is_blob => 0, is_numeric => 0, type => 'varchar(200)', default => ''}, + Description => + {read => 1, write => 1, sql_type => 12, length => 255, is_blob => 0, is_numeric => 0, type => 'varchar(255)', default => ''}, + ExecModule => + {read => 1, write => 1, sql_type => 12, length => 60, is_blob => 0, is_numeric => 0, type => 'varchar(60)', default => ''}, + Argument => + {read => 1, write => 1, sql_type => 12, length => 255, is_blob => 0, is_numeric => 0, type => 'varchar(255)', default => ''}, + Creator => + {read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'}, + Created => + {read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''}, + LastUpdatedBy => + {read => 1, auto => 1, sql_type => 4, length => 11, is_blob => 0, is_numeric => 1, type => 'int(11)', default => '0'}, + LastUpdated => + {read => 1, auto => 1, sql_type => 11, length => 0, is_blob => 0, is_numeric => 0, type => 'datetime', default => ''}, + + } +}; + + + eval "require RT::ScripAction_Overlay"; + if ($@ && $@ !~ qr{^Can't locate RT/ScripAction_Overlay.pm}) { + die $@; + }; + + eval "require RT::ScripAction_Vendor"; + if ($@ && $@ !~ qr{^Can't locate RT/ScripAction_Vendor.pm}) { + die $@; + }; + + eval "require RT::ScripAction_Local"; + if ($@ && $@ !~ qr{^Can't locate RT/ScripAction_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. + +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::ScripAction_Overlay, RT::ScripAction_Vendor, RT::ScripAction_Local + +=cut + + +1;