rt/lib/RT/Principal.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::Principal
  58
  59
  60 =head1 SYNOPSIS
  61
  62 =head1 DESCRIPTION
  63
  64 =head1 METHODS
  65
  66 =cut
  67
  68 package RT::Principal;
  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('Principals');
  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(16) 'PrincipalType'.
  91   int(11) 'ObjectId'.
  92   smallint(6) 'Disabled'.
  93
  94 =cut
  95
  96
  97
  98
  99 sub Create {
 100     my $self = shift;
 101     my %args = (
 102                 PrincipalType => '',
 103                 ObjectId => '',
 104                 Disabled => '0',
 105
 106                   @_);
 107     $self->SUPER::Create(
 108                          PrincipalType => $args{'PrincipalType'},
 109                          ObjectId => $args{'ObjectId'},
 110                          Disabled => $args{'Disabled'},
 111 );
 112
 113 }
 114
 115
 116
 117 =head2 id
 118
 119 Returns the current value of id.
 120 (In the database, id is stored as int(11).)
 121
 122
 123 =cut
 124
 125
 126 =head2 PrincipalType
 127
 128 Returns the current value of PrincipalType.
 129 (In the database, PrincipalType is stored as varchar(16).)
 130
 131
 132
 133 =head2 SetPrincipalType VALUE
 134
 135
 136 Set PrincipalType to VALUE.
 137 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 138 (In the database, PrincipalType will be stored as a varchar(16).)
 139
 140
 141 =cut
 142
 143
 144 =head2 ObjectId
 145
 146 Returns the current value of ObjectId.
 147 (In the database, ObjectId is stored as int(11).)
 148
 149
 150
 151 =head2 SetObjectId VALUE
 152
 153
 154 Set ObjectId to VALUE.
 155 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 156 (In the database, ObjectId will be stored as a int(11).)
 157
 158
 159 =cut
 160
 161
 162 =head2 Disabled
 163
 164 Returns the current value of Disabled.
 165 (In the database, Disabled is stored as smallint(6).)
 166
 167
 168
 169 =head2 SetDisabled VALUE
 170
 171
 172 Set Disabled to VALUE.
 173 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 174 (In the database, Disabled will be stored as a smallint(6).)
 175
 176
 177 =cut
 178
 179
 180
 181 sub _CoreAccessible {
 182     {
 183
 184         id =>
 185                 {read => 1, type => 'int(11)', default => ''},
 186         PrincipalType =>
 187                 {read => 1, write => 1, type => 'varchar(16)', default => ''},
 188         ObjectId =>
 189                 {read => 1, write => 1, type => 'int(11)', default => ''},
 190         Disabled =>
 191                 {read => 1, write => 1, type => 'smallint(6)', default => '0'},
 192
 193  }
 194 };
 195
 196
 197         eval "require RT::Principal_Overlay";
 198         if ($@ && $@ !~ qr{^Can't locate RT/Principal_Overlay.pm}) {
 199             die $@;
 200         };
 201
 202         eval "require RT::Principal_Vendor";
 203         if ($@ && $@ !~ qr{^Can't locate RT/Principal_Vendor.pm}) {
 204             die $@;
 205         };
 206
 207         eval "require RT::Principal_Local";
 208         if ($@ && $@ !~ qr{^Can't locate RT/Principal_Local.pm}) {
 209             die $@;
 210         };
 211
 212
 213
 214
 215 =head1 SEE ALSO
 216
 217 This class allows "overlay" methods to be placed
 218 into the following files _Overlay is for a System overlay by the original author,
 219 _Vendor is for 3rd-party vendor add-ons, while _Local is for site-local customizations.
 220
 221 These overlay files can contain new subs or subs to replace existing subs in this module.
 222
 223 If you'll be working with perl 5.6.0 or greater, each of these files should begin with the line
 224
 225    no warnings qw(redefine);
 226
 227 so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
 228
 229 RT::Principal_Overlay, RT::Principal_Vendor, RT::Principal_Local
 230
 231 =cut
 232
 233
 234 1;