rt/lib/RT/Transaction.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 # Autogenerated by DBIx::SearchBuilder factory (by <jesse@bestpractical.com>)
  49 # WARNING: THIS FILE IS AUTOGENERATED. ALL CHANGES TO THIS FILE WILL BE LOST.
  50 #
  51 # !! DO NOT EDIT THIS FILE !!
  52 #
  53
  54 use strict;
  55
  56
  57 =head1 NAME
  58
  59 RT::Transaction
  60
  61
  62 =head1 SYNOPSIS
  63
  64 =head1 DESCRIPTION
  65
  66 =head1 METHODS
  67
  68 =cut
  69
  70 package RT::Transaction;
  71 use RT::Record;
  72
  73
  74 use vars qw( @ISA );
  75 @ISA= qw( RT::Record );
  76
  77 sub _Init {
  78   my $self = shift;
  79
  80   $self->Table('Transactions');
  81   $self->SUPER::_Init(@_);
  82 }
  83
  84
  85
  86
  87
  88 =head2 Create PARAMHASH
  89
  90 Create takes a hash of values and creates a row in the database:
  91
  92   varchar(64) 'ObjectType'.
  93   int(11) 'ObjectId'.
  94   int(11) 'TimeTaken'.
  95   varchar(20) 'Type'.
  96   varchar(40) 'Field'.
  97   varchar(255) 'OldValue'.
  98   varchar(255) 'NewValue'.
  99   varchar(255) 'ReferenceType'.
 100   int(11) 'OldReference'.
 101   int(11) 'NewReference'.
 102   varchar(255) 'Data'.
 103
 104 =cut
 105
 106
 107
 108
 109 sub Create {
 110     my $self = shift;
 111     my %args = (
 112                 ObjectType => '',
 113                 ObjectId => '0',
 114                 TimeTaken => '0',
 115                 Type => '',
 116                 Field => '',
 117                 OldValue => '',
 118                 NewValue => '',
 119                 ReferenceType => '',
 120                 OldReference => '',
 121                 NewReference => '',
 122                 Data => '',
 123
 124                   @_);
 125     $self->SUPER::Create(
 126                          ObjectType => $args{'ObjectType'},
 127                          ObjectId => $args{'ObjectId'},
 128                          TimeTaken => $args{'TimeTaken'},
 129                          Type => $args{'Type'},
 130                          Field => $args{'Field'},
 131                          OldValue => $args{'OldValue'},
 132                          NewValue => $args{'NewValue'},
 133                          ReferenceType => $args{'ReferenceType'},
 134                          OldReference => $args{'OldReference'},
 135                          NewReference => $args{'NewReference'},
 136                          Data => $args{'Data'},
 137 );
 138
 139 }
 140
 141
 142
 143 =head2 id
 144
 145 Returns the current value of id.
 146 (In the database, id is stored as int(11).)
 147
 148
 149 =cut
 150
 151
 152 =head2 ObjectType
 153
 154 Returns the current value of ObjectType.
 155 (In the database, ObjectType is stored as varchar(64).)
 156
 157
 158
 159 =head2 SetObjectType VALUE
 160
 161
 162 Set ObjectType to VALUE.
 163 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 164 (In the database, ObjectType will be stored as a varchar(64).)
 165
 166
 167 =cut
 168
 169
 170 =head2 ObjectId
 171
 172 Returns the current value of ObjectId.
 173 (In the database, ObjectId is stored as int(11).)
 174
 175
 176
 177 =head2 SetObjectId VALUE
 178
 179
 180 Set ObjectId to VALUE.
 181 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 182 (In the database, ObjectId will be stored as a int(11).)
 183
 184
 185 =cut
 186
 187
 188 =head2 TimeTaken
 189
 190 Returns the current value of TimeTaken.
 191 (In the database, TimeTaken is stored as int(11).)
 192
 193
 194
 195 =head2 SetTimeTaken VALUE
 196
 197
 198 Set TimeTaken to VALUE.
 199 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 200 (In the database, TimeTaken will be stored as a int(11).)
 201
 202
 203 =cut
 204
 205
 206 =head2 Type
 207
 208 Returns the current value of Type.
 209 (In the database, Type is stored as varchar(20).)
 210
 211
 212
 213 =head2 SetType VALUE
 214
 215
 216 Set Type to VALUE.
 217 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 218 (In the database, Type will be stored as a varchar(20).)
 219
 220
 221 =cut
 222
 223
 224 =head2 Field
 225
 226 Returns the current value of Field.
 227 (In the database, Field is stored as varchar(40).)
 228
 229
 230
 231 =head2 SetField VALUE
 232
 233
 234 Set Field to VALUE.
 235 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 236 (In the database, Field will be stored as a varchar(40).)
 237
 238
 239 =cut
 240
 241
 242 =head2 OldValue
 243
 244 Returns the current value of OldValue.
 245 (In the database, OldValue is stored as varchar(255).)
 246
 247
 248
 249 =head2 SetOldValue VALUE
 250
 251
 252 Set OldValue to VALUE.
 253 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 254 (In the database, OldValue will be stored as a varchar(255).)
 255
 256
 257 =cut
 258
 259
 260 =head2 NewValue
 261
 262 Returns the current value of NewValue.
 263 (In the database, NewValue is stored as varchar(255).)
 264
 265
 266
 267 =head2 SetNewValue VALUE
 268
 269
 270 Set NewValue to VALUE.
 271 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 272 (In the database, NewValue will be stored as a varchar(255).)
 273
 274
 275 =cut
 276
 277
 278 =head2 ReferenceType
 279
 280 Returns the current value of ReferenceType.
 281 (In the database, ReferenceType is stored as varchar(255).)
 282
 283
 284
 285 =head2 SetReferenceType VALUE
 286
 287
 288 Set ReferenceType to VALUE.
 289 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 290 (In the database, ReferenceType will be stored as a varchar(255).)
 291
 292
 293 =cut
 294
 295
 296 =head2 OldReference
 297
 298 Returns the current value of OldReference.
 299 (In the database, OldReference is stored as int(11).)
 300
 301
 302
 303 =head2 SetOldReference VALUE
 304
 305
 306 Set OldReference to VALUE.
 307 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 308 (In the database, OldReference will be stored as a int(11).)
 309
 310
 311 =cut
 312
 313
 314 =head2 NewReference
 315
 316 Returns the current value of NewReference.
 317 (In the database, NewReference is stored as int(11).)
 318
 319
 320
 321 =head2 SetNewReference VALUE
 322
 323
 324 Set NewReference to VALUE.
 325 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 326 (In the database, NewReference will be stored as a int(11).)
 327
 328
 329 =cut
 330
 331
 332 =head2 Data
 333
 334 Returns the current value of Data.
 335 (In the database, Data is stored as varchar(255).)
 336
 337
 338
 339 =head2 SetData VALUE
 340
 341
 342 Set Data to VALUE.
 343 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 344 (In the database, Data will be stored as a varchar(255).)
 345
 346
 347 =cut
 348
 349
 350 =head2 Creator
 351
 352 Returns the current value of Creator.
 353 (In the database, Creator is stored as int(11).)
 354
 355
 356 =cut
 357
 358
 359 =head2 Created
 360
 361 Returns the current value of Created.
 362 (In the database, Created is stored as datetime.)
 363
 364
 365 =cut
 366
 367
 368
 369 sub _CoreAccessible {
 370     {
 371
 372         id =>
 373                 {read => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => ''},
 374         ObjectType =>
 375                 {read => 1, write => 1, sql_type => 12, length => 64,  is_blob => 0,  is_numeric => 0,  type => 'varchar(64)', default => ''},
 376         ObjectId =>
 377                 {read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 378         TimeTaken =>
 379                 {read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 380         Type =>
 381                 {read => 1, write => 1, sql_type => 12, length => 20,  is_blob => 0,  is_numeric => 0,  type => 'varchar(20)', default => ''},
 382         Field =>
 383                 {read => 1, write => 1, sql_type => 12, length => 40,  is_blob => 0,  is_numeric => 0,  type => 'varchar(40)', default => ''},
 384         OldValue =>
 385                 {read => 1, write => 1, sql_type => 12, length => 255,  is_blob => 0,  is_numeric => 0,  type => 'varchar(255)', default => ''},
 386         NewValue =>
 387                 {read => 1, write => 1, sql_type => 12, length => 255,  is_blob => 0,  is_numeric => 0,  type => 'varchar(255)', default => ''},
 388         ReferenceType =>
 389                 {read => 1, write => 1, sql_type => 12, length => 255,  is_blob => 0,  is_numeric => 0,  type => 'varchar(255)', default => ''},
 390         OldReference =>
 391                 {read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => ''},
 392         NewReference =>
 393                 {read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => ''},
 394         Data =>
 395                 {read => 1, write => 1, sql_type => 12, length => 255,  is_blob => 0,  is_numeric => 0,  type => 'varchar(255)', default => ''},
 396         Creator =>
 397                 {read => 1, auto => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 398         Created =>
 399                 {read => 1, auto => 1, sql_type => 11, length => 0,  is_blob => 0,  is_numeric => 0,  type => 'datetime', default => ''},
 400
 401  }
 402 };
 403
 404
 405         eval "require RT::Transaction_Overlay";
 406         if ($@ && $@ !~ qr{^Can't locate RT/Transaction_Overlay.pm}) {
 407             die $@;
 408         };
 409
 410         eval "require RT::Transaction_Vendor";
 411         if ($@ && $@ !~ qr{^Can't locate RT/Transaction_Vendor.pm}) {
 412             die $@;
 413         };
 414
 415         eval "require RT::Transaction_Local";
 416         if ($@ && $@ !~ qr{^Can't locate RT/Transaction_Local.pm}) {
 417             die $@;
 418         };
 419
 420
 421
 422
 423 =head1 SEE ALSO
 424
 425 This class allows "overlay" methods to be placed
 426 into the following files _Overlay is for a System overlay by the original author,
 427 _Vendor is for 3rd-party vendor add-ons, while _Local is for site-local customizations.
 428
 429 These overlay files can contain new subs or subs to replace existing subs in this module.
 430
 431 Each of these files should begin with the line
 432
 433    no warnings qw(redefine);
 434
 435 so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
 436
 437 RT::Transaction_Overlay, RT::Transaction_Vendor, RT::Transaction_Local
 438
 439 =cut
 440
 441
 442 1;