rt/lib/RT/Group.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::Group
  60
  61
  62 =head1 SYNOPSIS
  63
  64 =head1 DESCRIPTION
  65
  66 =head1 METHODS
  67
  68 =cut
  69
  70 package RT::Group;
  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('Groups');
  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(200) 'Name'.
  93   varchar(255) 'Description'.
  94   varchar(64) 'Domain'.
  95   varchar(64) 'Type'.
  96   int(11) 'Instance'.
  97
  98 =cut
  99
 100
 101
 102
 103 sub Create {
 104     my $self = shift;
 105     my %args = (
 106                 Name => '',
 107                 Description => '',
 108                 Domain => '',
 109                 Type => '',
 110                 Instance => '',
 111
 112                   @_);
 113     $self->SUPER::Create(
 114                          Name => $args{'Name'},
 115                          Description => $args{'Description'},
 116                          Domain => $args{'Domain'},
 117                          Type => $args{'Type'},
 118                          Instance => $args{'Instance'},
 119 );
 120
 121 }
 122
 123
 124
 125 =head2 id
 126
 127 Returns the current value of id.
 128 (In the database, id is stored as int(11).)
 129
 130
 131 =cut
 132
 133
 134 =head2 Name
 135
 136 Returns the current value of Name.
 137 (In the database, Name is stored as varchar(200).)
 138
 139
 140
 141 =head2 SetName VALUE
 142
 143
 144 Set Name to VALUE.
 145 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 146 (In the database, Name will be stored as a varchar(200).)
 147
 148
 149 =cut
 150
 151
 152 =head2 Description
 153
 154 Returns the current value of Description.
 155 (In the database, Description is stored as varchar(255).)
 156
 157
 158
 159 =head2 SetDescription VALUE
 160
 161
 162 Set Description to VALUE.
 163 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 164 (In the database, Description will be stored as a varchar(255).)
 165
 166
 167 =cut
 168
 169
 170 =head2 Domain
 171
 172 Returns the current value of Domain.
 173 (In the database, Domain is stored as varchar(64).)
 174
 175
 176
 177 =head2 SetDomain VALUE
 178
 179
 180 Set Domain to VALUE.
 181 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 182 (In the database, Domain will be stored as a varchar(64).)
 183
 184
 185 =cut
 186
 187
 188 =head2 Type
 189
 190 Returns the current value of Type.
 191 (In the database, Type is stored as varchar(64).)
 192
 193
 194
 195 =head2 SetType VALUE
 196
 197
 198 Set Type to VALUE.
 199 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 200 (In the database, Type will be stored as a varchar(64).)
 201
 202
 203 =cut
 204
 205
 206 =head2 Instance
 207
 208 Returns the current value of Instance.
 209 (In the database, Instance is stored as int(11).)
 210
 211
 212
 213 =head2 SetInstance VALUE
 214
 215
 216 Set Instance to VALUE.
 217 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 218 (In the database, Instance will be stored as a int(11).)
 219
 220
 221 =cut
 222
 223
 224
 225 sub _CoreAccessible {
 226     {
 227
 228         id =>
 229                 {read => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => ''},
 230         Name =>
 231                 {read => 1, write => 1, sql_type => 12, length => 200,  is_blob => 0,  is_numeric => 0,  type => 'varchar(200)', default => ''},
 232         Description =>
 233                 {read => 1, write => 1, sql_type => 12, length => 255,  is_blob => 0,  is_numeric => 0,  type => 'varchar(255)', default => ''},
 234         Domain =>
 235                 {read => 1, write => 1, sql_type => 12, length => 64,  is_blob => 0,  is_numeric => 0,  type => 'varchar(64)', default => ''},
 236         Type =>
 237                 {read => 1, write => 1, sql_type => 12, length => 64,  is_blob => 0,  is_numeric => 0,  type => 'varchar(64)', default => ''},
 238         Instance =>
 239                 {read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => ''},
 240
 241  }
 242 };
 243
 244
 245         eval "require RT::Group_Overlay";
 246         if ($@ && $@ !~ qr{^Can't locate RT/Group_Overlay.pm}) {
 247             die $@;
 248         };
 249
 250         eval "require RT::Group_Vendor";
 251         if ($@ && $@ !~ qr{^Can't locate RT/Group_Vendor.pm}) {
 252             die $@;
 253         };
 254
 255         eval "require RT::Group_Local";
 256         if ($@ && $@ !~ qr{^Can't locate RT/Group_Local.pm}) {
 257             die $@;
 258         };
 259
 260
 261
 262
 263 =head1 SEE ALSO
 264
 265 This class allows "overlay" methods to be placed
 266 into the following files _Overlay is for a System overlay by the original author,
 267 _Vendor is for 3rd-party vendor add-ons, while _Local is for site-local customizations.
 268
 269 These overlay files can contain new subs or subs to replace existing subs in this module.
 270
 271 Each of these files should begin with the line
 272
 273    no warnings qw(redefine);
 274
 275 so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
 276
 277 RT::Group_Overlay, RT::Group_Vendor, RT::Group_Local
 278
 279 =cut
 280
 281
 282 1;