rt/lib/RT/Queue.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::Queue
  60
  61
  62 =head1 SYNOPSIS
  63
  64 =head1 DESCRIPTION
  65
  66 =head1 METHODS
  67
  68 =cut
  69
  70 package RT::Queue;
  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('Queues');
  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(200) 'Name'.
  93   varchar(255) 'Description'.
  94   varchar(120) 'CorrespondAddress'.
  95   varchar(120) 'CommentAddress'.
  96   int(11) 'InitialPriority'.
  97   int(11) 'FinalPriority'.
  98   int(11) 'DefaultDueIn'.
  99   smallint(6) 'Disabled'.
 100
 101 =cut
 102
 103
 104
 105
 106 sub Create {
 107     my $self = shift;
 108     my %args = (
 109                 Name => '',
 110                 Description => '',
 111                 CorrespondAddress => '',
 112                 CommentAddress => '',
 113                 InitialPriority => '0',
 114                 FinalPriority => '0',
 115                 DefaultDueIn => '0',
 116                 Disabled => '0',
 117
 118                   @_);
 119     $self->SUPER::Create(
 120                          Name => $args{'Name'},
 121                          Description => $args{'Description'},
 122                          CorrespondAddress => $args{'CorrespondAddress'},
 123                          CommentAddress => $args{'CommentAddress'},
 124                          InitialPriority => $args{'InitialPriority'},
 125                          FinalPriority => $args{'FinalPriority'},
 126                          DefaultDueIn => $args{'DefaultDueIn'},
 127                          Disabled => $args{'Disabled'},
 128 );
 129
 130 }
 131
 132
 133
 134 =head2 id
 135
 136 Returns the current value of id.
 137 (In the database, id is stored as int(11).)
 138
 139
 140 =cut
 141
 142
 143 =head2 Name
 144
 145 Returns the current value of Name.
 146 (In the database, Name is stored as varchar(200).)
 147
 148
 149
 150 =head2 SetName VALUE
 151
 152
 153 Set Name to VALUE.
 154 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 155 (In the database, Name will be stored as a varchar(200).)
 156
 157
 158 =cut
 159
 160
 161 =head2 Description
 162
 163 Returns the current value of Description.
 164 (In the database, Description is stored as varchar(255).)
 165
 166
 167
 168 =head2 SetDescription VALUE
 169
 170
 171 Set Description to VALUE.
 172 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 173 (In the database, Description will be stored as a varchar(255).)
 174
 175
 176 =cut
 177
 178
 179 =head2 CorrespondAddress
 180
 181 Returns the current value of CorrespondAddress.
 182 (In the database, CorrespondAddress is stored as varchar(120).)
 183
 184
 185
 186 =head2 SetCorrespondAddress VALUE
 187
 188
 189 Set CorrespondAddress to VALUE.
 190 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 191 (In the database, CorrespondAddress will be stored as a varchar(120).)
 192
 193
 194 =cut
 195
 196
 197 =head2 CommentAddress
 198
 199 Returns the current value of CommentAddress.
 200 (In the database, CommentAddress is stored as varchar(120).)
 201
 202
 203
 204 =head2 SetCommentAddress VALUE
 205
 206
 207 Set CommentAddress to VALUE.
 208 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 209 (In the database, CommentAddress will be stored as a varchar(120).)
 210
 211
 212 =cut
 213
 214
 215 =head2 InitialPriority
 216
 217 Returns the current value of InitialPriority.
 218 (In the database, InitialPriority is stored as int(11).)
 219
 220
 221
 222 =head2 SetInitialPriority VALUE
 223
 224
 225 Set InitialPriority to VALUE.
 226 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 227 (In the database, InitialPriority will be stored as a int(11).)
 228
 229
 230 =cut
 231
 232
 233 =head2 FinalPriority
 234
 235 Returns the current value of FinalPriority.
 236 (In the database, FinalPriority is stored as int(11).)
 237
 238
 239
 240 =head2 SetFinalPriority VALUE
 241
 242
 243 Set FinalPriority to VALUE.
 244 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 245 (In the database, FinalPriority will be stored as a int(11).)
 246
 247
 248 =cut
 249
 250
 251 =head2 DefaultDueIn
 252
 253 Returns the current value of DefaultDueIn.
 254 (In the database, DefaultDueIn is stored as int(11).)
 255
 256
 257
 258 =head2 SetDefaultDueIn VALUE
 259
 260
 261 Set DefaultDueIn to VALUE.
 262 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 263 (In the database, DefaultDueIn will be stored as a int(11).)
 264
 265
 266 =cut
 267
 268
 269 =head2 Creator
 270
 271 Returns the current value of Creator.
 272 (In the database, Creator is stored as int(11).)
 273
 274
 275 =cut
 276
 277
 278 =head2 Created
 279
 280 Returns the current value of Created.
 281 (In the database, Created is stored as datetime.)
 282
 283
 284 =cut
 285
 286
 287 =head2 LastUpdatedBy
 288
 289 Returns the current value of LastUpdatedBy.
 290 (In the database, LastUpdatedBy is stored as int(11).)
 291
 292
 293 =cut
 294
 295
 296 =head2 LastUpdated
 297
 298 Returns the current value of LastUpdated.
 299 (In the database, LastUpdated is stored as datetime.)
 300
 301
 302 =cut
 303
 304
 305 =head2 Disabled
 306
 307 Returns the current value of Disabled.
 308 (In the database, Disabled is stored as smallint(6).)
 309
 310
 311
 312 =head2 SetDisabled VALUE
 313
 314
 315 Set Disabled to VALUE.
 316 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 317 (In the database, Disabled will be stored as a smallint(6).)
 318
 319
 320 =cut
 321
 322
 323
 324 sub _CoreAccessible {
 325     {
 326
 327         id =>
 328                 {read => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => ''},
 329         Name =>
 330                 {read => 1, write => 1, sql_type => 12, length => 200,  is_blob => 0,  is_numeric => 0,  type => 'varchar(200)', default => ''},
 331         Description =>
 332                 {read => 1, write => 1, sql_type => 12, length => 255,  is_blob => 0,  is_numeric => 0,  type => 'varchar(255)', default => ''},
 333         CorrespondAddress =>
 334                 {read => 1, write => 1, sql_type => 12, length => 120,  is_blob => 0,  is_numeric => 0,  type => 'varchar(120)', default => ''},
 335         CommentAddress =>
 336                 {read => 1, write => 1, sql_type => 12, length => 120,  is_blob => 0,  is_numeric => 0,  type => 'varchar(120)', default => ''},
 337         InitialPriority =>
 338                 {read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 339         FinalPriority =>
 340                 {read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 341         DefaultDueIn =>
 342                 {read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 343         Creator =>
 344                 {read => 1, auto => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 345         Created =>
 346                 {read => 1, auto => 1, sql_type => 11, length => 0,  is_blob => 0,  is_numeric => 0,  type => 'datetime', default => ''},
 347         LastUpdatedBy =>
 348                 {read => 1, auto => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 349         LastUpdated =>
 350                 {read => 1, auto => 1, sql_type => 11, length => 0,  is_blob => 0,  is_numeric => 0,  type => 'datetime', default => ''},
 351         Disabled =>
 352                 {read => 1, write => 1, sql_type => 5, length => 6,  is_blob => 0,  is_numeric => 1,  type => 'smallint(6)', default => '0'},
 353
 354  }
 355 };
 356
 357
 358         eval "require RT::Queue_Overlay";
 359         if ($@ && $@ !~ qr{^Can't locate RT/Queue_Overlay.pm}) {
 360             die $@;
 361         };
 362
 363         eval "require RT::Queue_Vendor";
 364         if ($@ && $@ !~ qr{^Can't locate RT/Queue_Vendor.pm}) {
 365             die $@;
 366         };
 367
 368         eval "require RT::Queue_Local";
 369         if ($@ && $@ !~ qr{^Can't locate RT/Queue_Local.pm}) {
 370             die $@;
 371         };
 372
 373
 374
 375
 376 =head1 SEE ALSO
 377
 378 This class allows "overlay" methods to be placed
 379 into the following files _Overlay is for a System overlay by the original author,
 380 _Vendor is for 3rd-party vendor add-ons, while _Local is for site-local customizations.
 381
 382 These overlay files can contain new subs or subs to replace existing subs in this module.
 383
 384 Each of these files should begin with the line
 385
 386    no warnings qw(redefine);
 387
 388 so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
 389
 390 RT::Queue_Overlay, RT::Queue_Vendor, RT::Queue_Local
 391
 392 =cut
 393
 394
 395 1;