rt/lib/RT/Template.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC
   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 # Autogenerated by DBIx::SearchBuilder factory (by <jesse@bestpractical.com>)
  50 # WARNING: THIS FILE IS AUTOGENERATED. ALL CHANGES TO THIS FILE WILL BE LOST.
  51 #
  52 # !! DO NOT EDIT THIS FILE !!
  53 #
  54
  55 use strict;
  56
  57
  58 =head1 NAME
  59
  60 RT::Template
  61
  62
  63 =head1 SYNOPSIS
  64
  65 =head1 DESCRIPTION
  66
  67 =head1 METHODS
  68
  69 =cut
  70
  71 package RT::Template;
  72 use RT::Record;
  73 use RT::Queue;
  74
  75
  76 use vars qw( @ISA );
  77 @ISA= qw( RT::Record );
  78
  79 sub _Init {
  80   my $self = shift;
  81
  82   $self->Table('Templates');
  83   $self->SUPER::_Init(@_);
  84 }
  85
  86
  87
  88
  89
  90 =head2 Create PARAMHASH
  91
  92 Create takes a hash of values and creates a row in the database:
  93
  94   int(11) 'Queue'.
  95   varchar(200) 'Name'.
  96   varchar(255) 'Description'.
  97   varchar(16) 'Type'.
  98   varchar(16) 'Language'.
  99   int(11) 'TranslationOf'.
 100   blob 'Content'.
 101
 102 =cut
 103
 104
 105
 106
 107 sub Create {
 108     my $self = shift;
 109     my %args = (
 110                 Queue => '0',
 111                 Name => '',
 112                 Description => '',
 113                 Type => '',
 114                 Language => '',
 115                 TranslationOf => '0',
 116                 Content => '',
 117
 118                   @_);
 119     $self->SUPER::Create(
 120                          Queue => $args{'Queue'},
 121                          Name => $args{'Name'},
 122                          Description => $args{'Description'},
 123                          Type => $args{'Type'},
 124                          Language => $args{'Language'},
 125                          TranslationOf => $args{'TranslationOf'},
 126                          Content => $args{'Content'},
 127 );
 128
 129 }
 130
 131
 132
 133 =head2 id
 134
 135 Returns the current value of id.
 136 (In the database, id is stored as int(11).)
 137
 138
 139 =cut
 140
 141
 142 =head2 Queue
 143
 144 Returns the current value of Queue.
 145 (In the database, Queue is stored as int(11).)
 146
 147
 148
 149 =head2 SetQueue VALUE
 150
 151
 152 Set Queue to VALUE.
 153 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 154 (In the database, Queue will be stored as a int(11).)
 155
 156
 157 =cut
 158
 159
 160 =head2 QueueObj
 161
 162 Returns the Queue Object which has the id returned by Queue
 163
 164
 165 =cut
 166
 167 sub QueueObj {
 168         my $self = shift;
 169         my $Queue =  RT::Queue->new($self->CurrentUser);
 170         $Queue->Load($self->__Value('Queue'));
 171         return($Queue);
 172 }
 173
 174 =head2 Name
 175
 176 Returns the current value of Name.
 177 (In the database, Name is stored as varchar(200).)
 178
 179
 180
 181 =head2 SetName VALUE
 182
 183
 184 Set Name to VALUE.
 185 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 186 (In the database, Name will be stored as a varchar(200).)
 187
 188
 189 =cut
 190
 191
 192 =head2 Description
 193
 194 Returns the current value of Description.
 195 (In the database, Description is stored as varchar(255).)
 196
 197
 198
 199 =head2 SetDescription VALUE
 200
 201
 202 Set Description to VALUE.
 203 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 204 (In the database, Description will be stored as a varchar(255).)
 205
 206
 207 =cut
 208
 209
 210 =head2 Type
 211
 212 Returns the current value of Type.
 213 (In the database, Type is stored as varchar(16).)
 214
 215
 216
 217 =head2 SetType VALUE
 218
 219
 220 Set Type to VALUE.
 221 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 222 (In the database, Type will be stored as a varchar(16).)
 223
 224
 225 =cut
 226
 227
 228 =head2 Language
 229
 230 Returns the current value of Language.
 231 (In the database, Language is stored as varchar(16).)
 232
 233
 234
 235 =head2 SetLanguage VALUE
 236
 237
 238 Set Language to VALUE.
 239 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 240 (In the database, Language will be stored as a varchar(16).)
 241
 242
 243 =cut
 244
 245
 246 =head2 TranslationOf
 247
 248 Returns the current value of TranslationOf.
 249 (In the database, TranslationOf is stored as int(11).)
 250
 251
 252
 253 =head2 SetTranslationOf VALUE
 254
 255
 256 Set TranslationOf to VALUE.
 257 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 258 (In the database, TranslationOf will be stored as a int(11).)
 259
 260
 261 =cut
 262
 263
 264 =head2 Content
 265
 266 Returns the current value of Content.
 267 (In the database, Content is stored as blob.)
 268
 269
 270
 271 =head2 SetContent VALUE
 272
 273
 274 Set Content to VALUE.
 275 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 276 (In the database, Content will be stored as a blob.)
 277
 278
 279 =cut
 280
 281
 282 =head2 LastUpdated
 283
 284 Returns the current value of LastUpdated.
 285 (In the database, LastUpdated is stored as datetime.)
 286
 287
 288 =cut
 289
 290
 291 =head2 LastUpdatedBy
 292
 293 Returns the current value of LastUpdatedBy.
 294 (In the database, LastUpdatedBy is stored as int(11).)
 295
 296
 297 =cut
 298
 299
 300 =head2 Creator
 301
 302 Returns the current value of Creator.
 303 (In the database, Creator is stored as int(11).)
 304
 305
 306 =cut
 307
 308
 309 =head2 Created
 310
 311 Returns the current value of Created.
 312 (In the database, Created is stored as datetime.)
 313
 314
 315 =cut
 316
 317
 318
 319 sub _CoreAccessible {
 320     {
 321
 322         id =>
 323                 {read => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => ''},
 324         Queue =>
 325                 {read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 326         Name =>
 327                 {read => 1, write => 1, sql_type => 12, length => 200,  is_blob => 0,  is_numeric => 0,  type => 'varchar(200)', default => ''},
 328         Description =>
 329                 {read => 1, write => 1, sql_type => 12, length => 255,  is_blob => 0,  is_numeric => 0,  type => 'varchar(255)', default => ''},
 330         Type =>
 331                 {read => 1, write => 1, sql_type => 12, length => 16,  is_blob => 0,  is_numeric => 0,  type => 'varchar(16)', default => ''},
 332         Language =>
 333                 {read => 1, write => 1, sql_type => 12, length => 16,  is_blob => 0,  is_numeric => 0,  type => 'varchar(16)', default => ''},
 334         TranslationOf =>
 335                 {read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 336         Content =>
 337                 {read => 1, write => 1, sql_type => -4, length => 0,  is_blob => 1,  is_numeric => 0,  type => 'blob', default => ''},
 338         LastUpdated =>
 339                 {read => 1, auto => 1, sql_type => 11, length => 0,  is_blob => 0,  is_numeric => 0,  type => 'datetime', default => ''},
 340         LastUpdatedBy =>
 341                 {read => 1, auto => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 342         Creator =>
 343                 {read => 1, auto => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 344         Created =>
 345                 {read => 1, auto => 1, sql_type => 11, length => 0,  is_blob => 0,  is_numeric => 0,  type => 'datetime', default => ''},
 346
 347  }
 348 };
 349
 350 RT::Base->_ImportOverlays();
 351
 352 =head1 SEE ALSO
 353
 354 This class allows "overlay" methods to be placed
 355 into the following files _Overlay is for a System overlay by the original author,
 356 _Vendor is for 3rd-party vendor add-ons, while _Local is for site-local customizations.
 357
 358 These overlay files can contain new subs or subs to replace existing subs in this module.
 359
 360 Each of these files should begin with the line
 361
 362    no warnings qw(redefine);
 363
 364 so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
 365
 366 RT::Template_Overlay, RT::Template_Vendor, RT::Template_Local
 367
 368 =cut
 369
 370
 371 1;