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