rt/lib/RT/ObjectCustomField.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::ObjectCustomField
  61
  62
  63 =head1 SYNOPSIS
  64
  65 =head1 DESCRIPTION
  66
  67 =head1 METHODS
  68
  69 =cut
  70
  71 package RT::ObjectCustomField;
  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('ObjectCustomFields');
  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   int(11) 'ObjectId'.
  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                 ObjectId => '0',
 108                 SortOrder => '0',
 109
 110                   @_);
 111     $self->SUPER::Create(
 112                          CustomField => $args{'CustomField'},
 113                          ObjectId => $args{'ObjectId'},
 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 ObjectId
 163
 164 Returns the current value of ObjectId.
 165 (In the database, ObjectId is stored as int(11).)
 166
 167
 168
 169 =head2 SetObjectId VALUE
 170
 171
 172 Set ObjectId to VALUE.
 173 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 174 (In the database, ObjectId will be stored as a int(11).)
 175
 176
 177 =cut
 178
 179
 180 =head2 SortOrder
 181
 182 Returns the current value of SortOrder.
 183 (In the database, SortOrder is stored as int(11).)
 184
 185
 186
 187 =head2 SetSortOrder VALUE
 188
 189
 190 Set SortOrder to VALUE.
 191 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 192 (In the database, SortOrder will be stored as a int(11).)
 193
 194
 195 =cut
 196
 197
 198 =head2 Creator
 199
 200 Returns the current value of Creator.
 201 (In the database, Creator is stored as int(11).)
 202
 203
 204 =cut
 205
 206
 207 =head2 Created
 208
 209 Returns the current value of Created.
 210 (In the database, Created is stored as datetime.)
 211
 212
 213 =cut
 214
 215
 216 =head2 LastUpdatedBy
 217
 218 Returns the current value of LastUpdatedBy.
 219 (In the database, LastUpdatedBy is stored as int(11).)
 220
 221
 222 =cut
 223
 224
 225 =head2 LastUpdated
 226
 227 Returns the current value of LastUpdated.
 228 (In the database, LastUpdated is stored as datetime.)
 229
 230
 231 =cut
 232
 233
 234
 235 sub _CoreAccessible {
 236     {
 237
 238         id =>
 239                 {read => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => ''},
 240         CustomField =>
 241                 {read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 242         ObjectId =>
 243                 {read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 244         SortOrder =>
 245                 {read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 246         Creator =>
 247                 {read => 1, auto => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 248         Created =>
 249                 {read => 1, auto => 1, sql_type => 11, length => 0,  is_blob => 0,  is_numeric => 0,  type => 'datetime', default => ''},
 250         LastUpdatedBy =>
 251                 {read => 1, auto => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
 252         LastUpdated =>
 253                 {read => 1, auto => 1, sql_type => 11, length => 0,  is_blob => 0,  is_numeric => 0,  type => 'datetime', default => ''},
 254
 255  }
 256 };
 257
 258 RT::Base->_ImportOverlays();
 259
 260 =head1 SEE ALSO
 261
 262 This class allows "overlay" methods to be placed
 263 into the following files _Overlay is for a System overlay by the original author,
 264 _Vendor is for 3rd-party vendor add-ons, while _Local is for site-local customizations.
 265
 266 These overlay files can contain new subs or subs to replace existing subs in this module.
 267
 268 Each of these files should begin with the line
 269
 270    no warnings qw(redefine);
 271
 272 so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
 273
 274 RT::ObjectCustomField_Overlay, RT::ObjectCustomField_Vendor, RT::ObjectCustomField_Local
 275
 276 =cut
 277
 278
 279 1;