rt/lib/RT/Principal.pm

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