rt/lib/RT/Principal.pm

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