rt/lib/RT/Link.pm

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