Putting 4.2.0 on top of 4.0.17
[usit-rt.git] / lib / RT / Condition.pm
CommitLineData
84fb5b46
MKG
1# BEGIN BPS TAGGED BLOCK {{{
2#
3# COPYRIGHT:
4#
403d7b0b 5# This software is Copyright (c) 1996-2013 Best Practical Solutions, LLC
84fb5b46
MKG
6# <sales@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/licenses/old-licenses/gpl-2.0.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
49=head1 NAME
50
51 RT::Condition - generic baseclass for scrip condition;
52
53=head1 SYNOPSIS
54
55 use RT::Condition;
56 my $foo = RT::Condition->new(
af59614d
MKG
57 TransactionObj => $tr,
58 TicketObj => $ti,
59 ScripObj => $scr,
60 Argument => $arg,
61 Type => $type);
84fb5b46
MKG
62
63 if ($foo->IsApplicable) {
af59614d 64 # do something
84fb5b46
MKG
65 }
66
67
68=head1 DESCRIPTION
69
70
71=head1 METHODS
72
73
74
75
76=cut
77
78package RT::Condition;
79
80use strict;
81use warnings;
82
83
84use base qw/RT::Base/;
85
86sub new {
87 my $proto = shift;
88 my $class = ref($proto) || $proto;
89 my $self = {};
90 bless ($self, $class);
91 $self->_Init(@_);
92 return $self;
93}
94
95sub _Init {
96 my $self = shift;
97 my %args = ( TransactionObj => undef,
af59614d
MKG
98 TicketObj => undef,
99 ScripObj => undef,
100 TemplateObj => undef,
101 Argument => undef,
102 ApplicableTransTypes => undef,
84fb5b46 103 CurrentUser => undef,
af59614d
MKG
104 @_ );
105
84fb5b46
MKG
106 $self->{'Argument'} = $args{'Argument'};
107 $self->{'ScripObj'} = $args{'ScripObj'};
108 $self->{'TicketObj'} = $args{'TicketObj'};
109 $self->{'TransactionObj'} = $args{'TransactionObj'};
110 $self->{'ApplicableTransTypes'} = $args{'ApplicableTransTypes'};
111 $self->CurrentUser($args{'CurrentUser'});
112}
113
114# Access Scripwide data
115
116
117=head2 Argument
118
119Return the optional argument associated with this ScripCondition
120
121=cut
122
123sub Argument {
124 my $self = shift;
125 return($self->{'Argument'});
126}
127
128
129=head2 TicketObj
130
131Return the ticket object we're talking about
132
133=cut
134
135sub TicketObj {
136 my $self = shift;
137 return($self->{'TicketObj'});
138}
139
140
141=head2 ScripObj
142
143Return the Scrip object we're talking about
144
145=cut
146
147sub ScripObj {
148 my $self = shift;
149 return($self->{'ScripObj'});
150}
151
152=head2 TransactionObj
153
154Return the transaction object we're talking about
155
156=cut
157
158sub TransactionObj {
159 my $self = shift;
160 return($self->{'TransactionObj'});
161}
162
163
164=head2 Type
165
166
167
168=cut
169
170sub ApplicableTransTypes {
171 my $self = shift;
172 return($self->{'ApplicableTransTypes'});
173}
174
175
176# Scrip methods
177
178
179#What does this type of Action does
180
181sub Describe {
182 my $self = shift;
183 return ($self->loc("No description for [_1]", ref $self));
184}
185
186
187#Parse the templates, get things ready to go.
188
189#If this rule applies to this transaction, return true.
190
191sub IsApplicable {
192 my $self = shift;
193 return(undef);
194}
195
196sub DESTROY {
197 my $self = shift;
198
199 # We need to clean up all the references that might maybe get
200 # oddly circular
201 $self->{'TemplateObj'} =undef
202 $self->{'TicketObj'} = undef;
203 $self->{'TransactionObj'} = undef;
204 $self->{'ScripObj'} = undef;
205
206}
207
208
209RT::Base->_ImportOverlays();
210
2111;