rt/lib/RT/Group.pm

   1 # BEGIN LICENSE BLOCK
   2 #
   3 # Copyright (c) 1996-2003 Jesse Vincent <jesse@bestpractical.com>
   4 #
   5 # (Except where explictly superceded by other copyright notices)
   6 #
   7 # This work is made available to you under the terms of Version 2 of
   8 # the GNU General Public License. A copy of that license should have
   9 # been provided with this software, but in any event can be snarfed
  10 # from www.gnu.org.
  11 #
  12 # This work is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 # General Public License for more details.
  16 #
  17 # Unless otherwise specified, all modifications, corrections or
  18 # extensions to this work which alter its source code become the
  19 # property of Best Practical Solutions, LLC when submitted for
  20 # inclusion in the work.
  21 #
  22 #
  23 # END LICENSE BLOCK
  24 # Autogenerated by DBIx::SearchBuilder factory (by <jesse@bestpractical.com>)
  25 # WARNING: THIS FILE IS AUTOGENERATED. ALL CHANGES TO THIS FILE WILL BE LOST.
  26 #
  27 # !! DO NOT EDIT THIS FILE !!
  28 #
  29
  30 use strict;
  31
  32
  33 =head1 NAME
  34
  35 RT::Group
  36
  37
  38 =head1 SYNOPSIS
  39
  40 =head1 DESCRIPTION
  41
  42 =head1 METHODS
  43
  44 =cut
  45
  46 package RT::Group;
  47 use RT::Record;
  48
  49
  50 use vars qw( @ISA );
  51 @ISA= qw( RT::Record );
  52
  53 sub _Init {
  54   my $self = shift;
  55
  56   $self->Table('Groups');
  57   $self->SUPER::_Init(@_);
  58 }
  59
  60
  61
  62
  63
  64 =item Create PARAMHASH
  65
  66 Create takes a hash of values and creates a row in the database:
  67
  68   varchar(200) 'Name'.
  69   varchar(255) 'Description'.
  70   varchar(64) 'Domain'.
  71   varchar(64) 'Type'.
  72   varchar(64) 'Instance'.
  73
  74 =cut
  75
  76
  77
  78
  79 sub Create {
  80     my $self = shift;
  81     my %args = (
  82                 Name => '',
  83                 Description => '',
  84                 Domain => '',
  85                 Type => '',
  86                 Instance => '',
  87
  88                   @_);
  89     $self->SUPER::Create(
  90                          Name => $args{'Name'},
  91                          Description => $args{'Description'},
  92                          Domain => $args{'Domain'},
  93                          Type => $args{'Type'},
  94                          Instance => $args{'Instance'},
  95 );
  96
  97 }
  98
  99
 100
 101 =item id
 102
 103 Returns the current value of id.
 104 (In the database, id is stored as int(11).)
 105
 106
 107 =cut
 108
 109
 110 =item Name
 111
 112 Returns the current value of Name.
 113 (In the database, Name is stored as varchar(200).)
 114
 115
 116
 117 =item SetName VALUE
 118
 119
 120 Set Name to VALUE.
 121 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 122 (In the database, Name will be stored as a varchar(200).)
 123
 124
 125 =cut
 126
 127
 128 =item Description
 129
 130 Returns the current value of Description.
 131 (In the database, Description is stored as varchar(255).)
 132
 133
 134
 135 =item SetDescription VALUE
 136
 137
 138 Set Description to VALUE.
 139 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 140 (In the database, Description will be stored as a varchar(255).)
 141
 142
 143 =cut
 144
 145
 146 =item Domain
 147
 148 Returns the current value of Domain.
 149 (In the database, Domain is stored as varchar(64).)
 150
 151
 152
 153 =item SetDomain VALUE
 154
 155
 156 Set Domain to VALUE.
 157 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 158 (In the database, Domain will be stored as a varchar(64).)
 159
 160
 161 =cut
 162
 163
 164 =item Type
 165
 166 Returns the current value of Type.
 167 (In the database, Type is stored as varchar(64).)
 168
 169
 170
 171 =item SetType VALUE
 172
 173
 174 Set Type to VALUE.
 175 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 176 (In the database, Type will be stored as a varchar(64).)
 177
 178
 179 =cut
 180
 181
 182 =item Instance
 183
 184 Returns the current value of Instance.
 185 (In the database, Instance is stored as varchar(64).)
 186
 187
 188
 189 =item SetInstance VALUE
 190
 191
 192 Set Instance to VALUE.
 193 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
 194 (In the database, Instance will be stored as a varchar(64).)
 195
 196
 197 =cut
 198
 199
 200
 201 sub _ClassAccessible {
 202     {
 203
 204         id =>
 205                 {read => 1, type => 'int(11)', default => ''},
 206         Name =>
 207                 {read => 1, write => 1, type => 'varchar(200)', default => ''},
 208         Description =>
 209                 {read => 1, write => 1, type => 'varchar(255)', default => ''},
 210         Domain =>
 211                 {read => 1, write => 1, type => 'varchar(64)', default => ''},
 212         Type =>
 213                 {read => 1, write => 1, type => 'varchar(64)', default => ''},
 214         Instance =>
 215                 {read => 1, write => 1, type => 'varchar(64)', default => ''},
 216
 217  }
 218 };
 219
 220
 221         eval "require RT::Group_Overlay";
 222         if ($@ && $@ !~ qr{^Can't locate RT/Group_Overlay.pm}) {
 223             die $@;
 224         };
 225
 226         eval "require RT::Group_Vendor";
 227         if ($@ && $@ !~ qr{^Can't locate RT/Group_Vendor.pm}) {
 228             die $@;
 229         };
 230
 231         eval "require RT::Group_Local";
 232         if ($@ && $@ !~ qr{^Can't locate RT/Group_Local.pm}) {
 233             die $@;
 234         };
 235
 236
 237
 238
 239 =head1 SEE ALSO
 240
 241 This class allows "overlay" methods to be placed
 242 into the following files _Overlay is for a System overlay by the original author,
 243 _Vendor is for 3rd-party vendor add-ons, while _Local is for site-local customizations.
 244
 245 These overlay files can contain new subs or subs to replace existing subs in this module.
 246
 247 If you'll be working with perl 5.6.0 or greater, each of these files should begin with the line
 248
 249    no warnings qw(redefine);
 250
 251 so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
 252
 253 RT::Group_Overlay, RT::Group_Vendor, RT::Group_Local
 254
 255 =cut
 256
 257
 258 1;