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