rt/lib/RT/CustomFieldValue.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2005 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., 675 Mass Ave, Cambridge, MA 02139, USA.
  26 #
  27 #
  28 # CONTRIBUTION SUBMISSION POLICY:
  29 #
  30 # (The following paragraph is not intended to limit the rights granted
  31 # to you to modify and distribute this software under the terms of
  32 # the GNU General Public License and is only of importance to you if
  33 # you choose to contribute your changes and enhancements to the
  34 # community by submitting them to Best Practical Solutions, LLC.)
  35 #
  36 # By intentionally submitting any modifications, corrections or
  37 # derivatives to this work, or any other work intended for use with
  38 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  39 # you are the copyright holder for those contributions and you grant
  40 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  41 # royalty-free, perpetual, license to use, copy, create derivative
  42 # works based on those contributions, and sublicense and distribute
  43 # those contributions and any derivatives thereof.
  44 #
  45 # END BPS TAGGED BLOCK }}}
  46 # Autogenerated by DBIx::SearchBuilder factory (by <jesse@bestpractical.com>)
  47 # WARNING: THIS FILE IS AUTOGENERATED. ALL CHANGES TO THIS FILE WILL BE LOST.
  48 #
  49 # !! DO NOT EDIT THIS FILE !!
  50 #
  51
  52 use strict;
  53
  54
  55 =head1 NAME
  56
  57 RT::CustomFieldValue
  58
  59
  60 =head1 SYNOPSIS
  61
  62 =head1 DESCRIPTION
  63
  64 =head1 METHODS
  65
  66 =cut
  67
  68 package RT::CustomFieldValue;
  69 use RT::Record;
  70 use RT::CustomField;
  71
  72
  73 use vars qw( @ISA );
  74 @ISA= qw( RT::Record );
  75
  76 sub _Init {
  77   my $self = shift;
  78
  79   $self->Table('CustomFieldValues');
  80   $self->SUPER::_Init(@_);
  81 }
  82
  83
  84
  85
  86
  87 =head2 Create PARAMHASH
  88
  89 Create takes a hash of values and creates a row in the database:
  90
  91   int(11) 'CustomField'.
  92   varchar(200) 'Name'.
  93   varchar(255) 'Description'.
  94   int(11) 'SortOrder'.
  95
  96 =cut
  97
  98
  99
 100
 101 sub Create {
 102     my $self = shift;
 103     my %args = (
 104                 CustomField => '0',
 105                 Name => '',
 106                 Description => '',
 107                 SortOrder => '0',
 108
 109                   @_);
 110     $self->SUPER::Create(
 111                          CustomField => $args{'CustomField'},
 112                          Name => $args{'Name'},
 113                          Description => $args{'Description'},
 114                          SortOrder => $args{'SortOrder'},
 115 );
 116
 117 }
 118
 119
 120
 121 =head2 id
 122
 123 Returns the current value of id.
 124 (In the database, id is stored as int(11).)
 125
 126
 127 =cut
 128
 129
 130 =head2 CustomField
 131
 132 Returns the current value of CustomField.
 133 (In the database, CustomField is stored as int(11).)
 134
 135
 136
 137 =head2 SetCustomField VALUE
 138
 139
 140 Set CustomField to VALUE.
 141 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 142 (In the database, CustomField will be stored as a int(11).)
 143
 144
 145 =cut
 146
 147
 148 =head2 CustomFieldObj
 149
 150 Returns the CustomField Object which has the id returned by CustomField
 151
 152
 153 =cut
 154
 155 sub CustomFieldObj {
 156         my $self = shift;
 157         my $CustomField =  RT::CustomField->new($self->CurrentUser);
 158         $CustomField->Load($self->__Value('CustomField'));
 159         return($CustomField);
 160 }
 161
 162 =head2 Name
 163
 164 Returns the current value of Name.
 165 (In the database, Name is stored as varchar(200).)
 166
 167
 168
 169 =head2 SetName VALUE
 170
 171
 172 Set Name to VALUE.
 173 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 174 (In the database, Name will be stored as a varchar(200).)
 175
 176
 177 =cut
 178
 179
 180 =head2 Description
 181
 182 Returns the current value of Description.
 183 (In the database, Description is stored as varchar(255).)
 184
 185
 186
 187 =head2 SetDescription VALUE
 188
 189
 190 Set Description to VALUE.
 191 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 192 (In the database, Description will be stored as a varchar(255).)
 193
 194
 195 =cut
 196
 197
 198 =head2 SortOrder
 199
 200 Returns the current value of SortOrder.
 201 (In the database, SortOrder is stored as int(11).)
 202
 203
 204
 205 =head2 SetSortOrder VALUE
 206
 207
 208 Set SortOrder to VALUE.
 209 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 210 (In the database, SortOrder will be stored as a int(11).)
 211
 212
 213 =cut
 214
 215
 216 =head2 Creator
 217
 218 Returns the current value of Creator.
 219 (In the database, Creator is stored as int(11).)
 220
 221
 222 =cut
 223
 224
 225 =head2 Created
 226
 227 Returns the current value of Created.
 228 (In the database, Created is stored as datetime.)
 229
 230
 231 =cut
 232
 233
 234 =head2 LastUpdatedBy
 235
 236 Returns the current value of LastUpdatedBy.
 237 (In the database, LastUpdatedBy is stored as int(11).)
 238
 239
 240 =cut
 241
 242
 243 =head2 LastUpdated
 244
 245 Returns the current value of LastUpdated.
 246 (In the database, LastUpdated is stored as datetime.)
 247
 248
 249 =cut
 250
 251
 252
 253 sub _CoreAccessible {
 254     {
 255
 256         id =>
 257                 {read => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => ''},
 258         CustomField =>
 259                 {read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 260         Name =>
 261                 {read => 1, write => 1, sql_type => 12, length => 200,  is_blob => 0,  is_numeric => 0,  type => 'varchar(200)', default => ''},
 262         Description =>
 263                 {read => 1, write => 1, sql_type => 12, length => 255,  is_blob => 0,  is_numeric => 0,  type => 'varchar(255)', default => ''},
 264         SortOrder =>
 265                 {read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 266         Creator =>
 267                 {read => 1, auto => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 268         Created =>
 269                 {read => 1, auto => 1, sql_type => 11, length => 0,  is_blob => 0,  is_numeric => 0,  type => 'datetime', default => ''},
 270         LastUpdatedBy =>
 271                 {read => 1, auto => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 272         LastUpdated =>
 273                 {read => 1, auto => 1, sql_type => 11, length => 0,  is_blob => 0,  is_numeric => 0,  type => 'datetime', default => ''},
 274
 275  }
 276 };
 277
 278
 279         eval "require RT::CustomFieldValue_Overlay";
 280         if ($@ && $@ !~ qr{^Can't locate RT/CustomFieldValue_Overlay.pm}) {
 281             die $@;
 282         };
 283
 284         eval "require RT::CustomFieldValue_Vendor";
 285         if ($@ && $@ !~ qr{^Can't locate RT/CustomFieldValue_Vendor.pm}) {
 286             die $@;
 287         };
 288
 289         eval "require RT::CustomFieldValue_Local";
 290         if ($@ && $@ !~ qr{^Can't locate RT/CustomFieldValue_Local.pm}) {
 291             die $@;
 292         };
 293
 294
 295
 296
 297 =head1 SEE ALSO
 298
 299 This class allows "overlay" methods to be placed
 300 into the following files _Overlay is for a System overlay by the original author,
 301 _Vendor is for 3rd-party vendor add-ons, while _Local is for site-local customizations.
 302
 303 These overlay files can contain new subs or subs to replace existing subs in this module.
 304
 305 Each of these files should begin with the line
 306
 307    no warnings qw(redefine);
 308
 309 so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
 310
 311 RT::CustomFieldValue_Overlay, RT::CustomFieldValue_Vendor, RT::CustomFieldValue_Local
 312
 313 =cut
 314
 315
 316 1;