rt/lib/RT/Condition/Generic.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2007 Best Practical Solutions, LLC
   6 #                                          <jesse@bestpractical.com>
   7 #
   8 # (Except where explicitly superseded by other copyright notices)
   9 #
  10 #
  11 # LICENSE:
  12 #
  13 # This work is made available to you under the terms of Version 2 of
  14 # the GNU General Public License. A copy of that license should have
  15 # been provided with this software, but in any event can be snarfed
  16 # from www.gnu.org.
  17 #
  18 # This work is distributed in the hope that it will be useful, but
  19 # WITHOUT ANY WARRANTY; without even the implied warranty of
  20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21 # General Public License for more details.
  22 #
  23 # You should have received a copy of the GNU General Public License
  24 # along with this program; if not, write to the Free Software
  25 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  26 # 02110-1301 or visit their web page on the internet at
  27 # http://www.gnu.org/copyleft/gpl.html.
  28 #
  29 #
  30 # CONTRIBUTION SUBMISSION POLICY:
  31 #
  32 # (The following paragraph is not intended to limit the rights granted
  33 # to you to modify and distribute this software under the terms of
  34 # the GNU General Public License and is only of importance to you if
  35 # you choose to contribute your changes and enhancements to the
  36 # community by submitting them to Best Practical Solutions, LLC.)
  37 #
  38 # By intentionally submitting any modifications, corrections or
  39 # derivatives to this work, or any other work intended for use with
  40 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  41 # you are the copyright holder for those contributions and you grant
  42 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  43 # royalty-free, perpetual, license to use, copy, create derivative
  44 # works based on those contributions, and sublicense and distribute
  45 # those contributions and any derivatives thereof.
  46 #
  47 # END BPS TAGGED BLOCK }}}
  48 =head1 NAME
  49
  50   RT::Condition::Generic - ;
  51
  52 =head1 SYNOPSIS
  53
  54     use RT::Condition::Generic;
  55     my $foo = RT::Condition::Generic->new(
  56                 TransactionObj => $tr,
  57                 TicketObj => $ti,
  58                 ScripObj => $scr,
  59                 Argument => $arg,
  60                 Type => $type);
  61
  62     if ($foo->IsApplicable) {
  63            # do something
  64     }
  65
  66
  67 =head1 DESCRIPTION
  68
  69
  70 =head1 METHODS
  71
  72
  73 =begin testing
  74
  75 ok (require RT::Condition::Generic);
  76
  77 =end testing
  78
  79
  80 =cut
  81
  82 package RT::Condition::Generic;
  83
  84 use strict;
  85 use base qw/RT::Base/;
  86
  87 # {{{ sub new
  88 sub new  {
  89   my $proto = shift;
  90   my $class = ref($proto) || $proto;
  91   my $self  = {};
  92   bless ($self, $class);
  93   $self->_Init(@_);
  94   return $self;
  95 }
  96 # }}}
  97
  98 # {{{ sub _Init
  99 sub _Init  {
 100   my $self = shift;
 101   my %args = ( TransactionObj => undef,
 102                TicketObj => undef,
 103                ScripObj => undef,
 104                TemplateObj => undef,
 105                Argument => undef,
 106                ApplicableTransTypes => undef,
 107            CurrentUser => undef,
 108                @_ );
 109
 110   $self->{'Argument'} = $args{'Argument'};
 111   $self->{'ScripObj'} = $args{'ScripObj'};
 112   $self->{'TicketObj'} = $args{'TicketObj'};
 113   $self->{'TransactionObj'} = $args{'TransactionObj'};
 114   $self->{'ApplicableTransTypes'} = $args{'ApplicableTransTypes'};
 115   $self->CurrentUser($args{'CurrentUser'});
 116 }
 117 # }}}
 118
 119 # Access Scripwide data
 120
 121 # {{{ sub Argument
 122
 123 =head2 Argument
 124
 125 Return the optional argument associated with this ScripCondition
 126
 127 =cut
 128
 129 sub Argument  {
 130   my $self = shift;
 131   return($self->{'Argument'});
 132 }
 133 # }}}
 134
 135 # {{{ sub TicketObj
 136
 137 =head2 TicketObj
 138
 139 Return the ticket object we're talking about
 140
 141 =cut
 142
 143 sub TicketObj  {
 144   my $self = shift;
 145   return($self->{'TicketObj'});
 146 }
 147 # }}}
 148
 149 # {{{ sub ScripObj
 150
 151 =head2 ScripObj
 152
 153 Return the Scrip object we're talking about
 154
 155 =cut
 156
 157 sub ScripObj  {
 158   my $self = shift;
 159   return($self->{'ScripObj'});
 160 }
 161 # }}}
 162 # {{{ sub TransactionObj
 163
 164 =head2 TransactionObj
 165
 166 Return the transaction object we're talking about
 167
 168 =cut
 169
 170 sub TransactionObj  {
 171   my $self = shift;
 172   return($self->{'TransactionObj'});
 173 }
 174 # }}}
 175
 176 # {{{ sub Type
 177
 178 =head2 Type
 179
 180
 181
 182 =cut
 183
 184 sub ApplicableTransTypes  {
 185   my $self = shift;
 186   return($self->{'ApplicableTransTypes'});
 187 }
 188 # }}}
 189
 190
 191 # Scrip methods
 192
 193
 194 #What does this type of Action does
 195
 196 # {{{ sub Describe
 197 sub Describe  {
 198   my $self = shift;
 199   return ($self->loc("No description for [_1]", ref $self));
 200 }
 201 # }}}
 202
 203
 204 #Parse the templates, get things ready to go.
 205
 206 #If this rule applies to this transaction, return true.
 207
 208 # {{{ sub IsApplicable
 209 sub IsApplicable  {
 210   my $self = shift;
 211   return(undef);
 212 }
 213 # }}}
 214
 215 # {{{ sub DESTROY
 216 sub DESTROY {
 217     my $self = shift;
 218
 219     # We need to clean up all the references that might maybe get
 220     # oddly circular
 221     $self->{'TemplateObj'} =undef
 222     $self->{'TicketObj'} = undef;
 223     $self->{'TransactionObj'} = undef;
 224     $self->{'ScripObj'} = undef;
 225
 226 }
 227
 228 # }}}
 229
 230 eval "require RT::Condition::Generic_Vendor";
 231 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Condition/Generic_Vendor.pm});
 232 eval "require RT::Condition::Generic_Local";
 233 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Condition/Generic_Local.pm});
 234
 235 1;