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