rt/lib/RT/CustomFieldValue.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::CustomFieldValue
  60
  61
  62 =head1 SYNOPSIS
  63
  64 =head1 DESCRIPTION
  65
  66 =head1 METHODS
  67
  68 =cut
  69
  70 package RT::CustomFieldValue;
  71 use RT::Record;
  72 use RT::CustomField;
  73
  74
  75 use vars qw( @ISA );
  76 @ISA= qw( RT::Record );
  77
  78 sub _Init {
  79   my $self = shift;
  80
  81   $self->Table('CustomFieldValues');
  82   $self->SUPER::_Init(@_);
  83 }
  84
  85
  86
  87
  88
  89 =head2 Create PARAMHASH
  90
  91 Create takes a hash of values and creates a row in the database:
  92
  93   int(11) 'CustomField'.
  94   varchar(200) 'Name'.
  95   varchar(255) 'Description'.
  96   int(11) 'SortOrder'.
  97
  98 =cut
  99
 100
 101
 102
 103 sub Create {
 104     my $self = shift;
 105     my %args = (
 106                 CustomField => '0',
 107                 Name => '',
 108                 Description => '',
 109                 SortOrder => '0',
 110
 111                   @_);
 112     $self->SUPER::Create(
 113                          CustomField => $args{'CustomField'},
 114                          Name => $args{'Name'},
 115                          Description => $args{'Description'},
 116                          SortOrder => $args{'SortOrder'},
 117 );
 118
 119 }
 120
 121
 122
 123 =head2 id
 124
 125 Returns the current value of id.
 126 (In the database, id is stored as int(11).)
 127
 128
 129 =cut
 130
 131
 132 =head2 CustomField
 133
 134 Returns the current value of CustomField.
 135 (In the database, CustomField is stored as int(11).)
 136
 137
 138
 139 =head2 SetCustomField VALUE
 140
 141
 142 Set CustomField to VALUE.
 143 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 144 (In the database, CustomField will be stored as a int(11).)
 145
 146
 147 =cut
 148
 149
 150 =head2 CustomFieldObj
 151
 152 Returns the CustomField Object which has the id returned by CustomField
 153
 154
 155 =cut
 156
 157 sub CustomFieldObj {
 158         my $self = shift;
 159         my $CustomField =  RT::CustomField->new($self->CurrentUser);
 160         $CustomField->Load($self->__Value('CustomField'));
 161         return($CustomField);
 162 }
 163
 164 =head2 Name
 165
 166 Returns the current value of Name.
 167 (In the database, Name is stored as varchar(200).)
 168
 169
 170
 171 =head2 SetName VALUE
 172
 173
 174 Set Name to VALUE.
 175 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 176 (In the database, Name will be stored as a varchar(200).)
 177
 178
 179 =cut
 180
 181
 182 =head2 Description
 183
 184 Returns the current value of Description.
 185 (In the database, Description is stored as varchar(255).)
 186
 187
 188
 189 =head2 SetDescription VALUE
 190
 191
 192 Set Description to VALUE.
 193 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 194 (In the database, Description will be stored as a varchar(255).)
 195
 196
 197 =cut
 198
 199
 200 =head2 SortOrder
 201
 202 Returns the current value of SortOrder.
 203 (In the database, SortOrder is stored as int(11).)
 204
 205
 206
 207 =head2 SetSortOrder VALUE
 208
 209
 210 Set SortOrder to VALUE.
 211 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 212 (In the database, SortOrder will be stored as a int(11).)
 213
 214
 215 =cut
 216
 217
 218 =head2 Creator
 219
 220 Returns the current value of Creator.
 221 (In the database, Creator is stored as int(11).)
 222
 223
 224 =cut
 225
 226
 227 =head2 Created
 228
 229 Returns the current value of Created.
 230 (In the database, Created is stored as datetime.)
 231
 232
 233 =cut
 234
 235
 236 =head2 LastUpdatedBy
 237
 238 Returns the current value of LastUpdatedBy.
 239 (In the database, LastUpdatedBy is stored as int(11).)
 240
 241
 242 =cut
 243
 244
 245 =head2 LastUpdated
 246
 247 Returns the current value of LastUpdated.
 248 (In the database, LastUpdated is stored as datetime.)
 249
 250
 251 =cut
 252
 253
 254
 255 sub _CoreAccessible {
 256     {
 257
 258         id =>
 259                 {read => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => ''},
 260         CustomField =>
 261                 {read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 262         Name =>
 263                 {read => 1, write => 1, sql_type => 12, length => 200,  is_blob => 0,  is_numeric => 0,  type => 'varchar(200)', default => ''},
 264         Description =>
 265                 {read => 1, write => 1, sql_type => 12, length => 255,  is_blob => 0,  is_numeric => 0,  type => 'varchar(255)', default => ''},
 266         SortOrder =>
 267                 {read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 268         Creator =>
 269                 {read => 1, auto => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 270         Created =>
 271                 {read => 1, auto => 1, sql_type => 11, length => 0,  is_blob => 0,  is_numeric => 0,  type => 'datetime', default => ''},
 272         LastUpdatedBy =>
 273                 {read => 1, auto => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 274         LastUpdated =>
 275                 {read => 1, auto => 1, sql_type => 11, length => 0,  is_blob => 0,  is_numeric => 0,  type => 'datetime', default => ''},
 276
 277  }
 278 };
 279
 280
 281         eval "require RT::CustomFieldValue_Overlay";
 282         if ($@ && $@ !~ qr{^Can't locate RT/CustomFieldValue_Overlay.pm}) {
 283             die $@;
 284         };
 285
 286         eval "require RT::CustomFieldValue_Vendor";
 287         if ($@ && $@ !~ qr{^Can't locate RT/CustomFieldValue_Vendor.pm}) {
 288             die $@;
 289         };
 290
 291         eval "require RT::CustomFieldValue_Local";
 292         if ($@ && $@ !~ qr{^Can't locate RT/CustomFieldValue_Local.pm}) {
 293             die $@;
 294         };
 295
 296
 297
 298
 299 =head1 SEE ALSO
 300
 301 This class allows "overlay" methods to be placed
 302 into the following files _Overlay is for a System overlay by the original author,
 303 _Vendor is for 3rd-party vendor add-ons, while _Local is for site-local customizations.
 304
 305 These overlay files can contain new subs or subs to replace existing subs in this module.
 306
 307 Each of these files should begin with the line
 308
 309    no warnings qw(redefine);
 310
 311 so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
 312
 313 RT::CustomFieldValue_Overlay, RT::CustomFieldValue_Vendor, RT::CustomFieldValue_Local
 314
 315 =cut
 316
 317
 318 1;