import rt 3.6.4
[freeside.git] / rt / lib / RT / Attribute.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::Attribute
60
61
62 =head1 SYNOPSIS
63
64 =head1 DESCRIPTION
65
66 =head1 METHODS
67
68 =cut
69
70 package RT::Attribute;
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('Attributes');
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(255) 'Name'.
93   varchar(255) 'Description'.
94   text 'Content'.
95   varchar(16) 'ContentType'.
96   varchar(64) 'ObjectType'.
97   int(11) 'ObjectId'.
98
99 =cut
100
101
102
103
104 sub Create {
105     my $self = shift;
106     my %args = ( 
107                 Name => '',
108                 Description => '',
109                 Content => '',
110                 ContentType => '',
111                 ObjectType => '',
112                 ObjectId => '',
113
114                   @_);
115     $self->SUPER::Create(
116                          Name => $args{'Name'},
117                          Description => $args{'Description'},
118                          Content => $args{'Content'},
119                          ContentType => $args{'ContentType'},
120                          ObjectType => $args{'ObjectType'},
121                          ObjectId => $args{'ObjectId'},
122 );
123
124 }
125
126
127
128 =head2 id
129
130 Returns the current value of id. 
131 (In the database, id is stored as int(11).)
132
133
134 =cut
135
136
137 =head2 Name
138
139 Returns the current value of Name. 
140 (In the database, Name is stored as varchar(255).)
141
142
143
144 =head2 SetName VALUE
145
146
147 Set Name to VALUE. 
148 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
149 (In the database, Name will be stored as a varchar(255).)
150
151
152 =cut
153
154
155 =head2 Description
156
157 Returns the current value of Description. 
158 (In the database, Description is stored as varchar(255).)
159
160
161
162 =head2 SetDescription VALUE
163
164
165 Set Description to VALUE. 
166 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
167 (In the database, Description will be stored as a varchar(255).)
168
169
170 =cut
171
172
173 =head2 Content
174
175 Returns the current value of Content. 
176 (In the database, Content is stored as text.)
177
178
179
180 =head2 SetContent VALUE
181
182
183 Set Content to VALUE. 
184 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
185 (In the database, Content will be stored as a text.)
186
187
188 =cut
189
190
191 =head2 ContentType
192
193 Returns the current value of ContentType. 
194 (In the database, ContentType is stored as varchar(16).)
195
196
197
198 =head2 SetContentType VALUE
199
200
201 Set ContentType to VALUE. 
202 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
203 (In the database, ContentType will be stored as a varchar(16).)
204
205
206 =cut
207
208
209 =head2 ObjectType
210
211 Returns the current value of ObjectType. 
212 (In the database, ObjectType is stored as varchar(64).)
213
214
215
216 =head2 SetObjectType VALUE
217
218
219 Set ObjectType to VALUE. 
220 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
221 (In the database, ObjectType will be stored as a varchar(64).)
222
223
224 =cut
225
226
227 =head2 ObjectId
228
229 Returns the current value of ObjectId. 
230 (In the database, ObjectId is stored as int(11).)
231
232
233
234 =head2 SetObjectId VALUE
235
236
237 Set ObjectId to VALUE. 
238 Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
239 (In the database, ObjectId will be stored as a int(11).)
240
241
242 =cut
243
244
245 =head2 Creator
246
247 Returns the current value of Creator. 
248 (In the database, Creator is stored as int(11).)
249
250
251 =cut
252
253
254 =head2 Created
255
256 Returns the current value of Created. 
257 (In the database, Created is stored as datetime.)
258
259
260 =cut
261
262
263 =head2 LastUpdatedBy
264
265 Returns the current value of LastUpdatedBy. 
266 (In the database, LastUpdatedBy is stored as int(11).)
267
268
269 =cut
270
271
272 =head2 LastUpdated
273
274 Returns the current value of LastUpdated. 
275 (In the database, LastUpdated is stored as datetime.)
276
277
278 =cut
279
280
281
282 sub _CoreAccessible {
283     {
284      
285         id =>
286                 {read => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => ''},
287         Name => 
288                 {read => 1, write => 1, sql_type => 12, length => 255,  is_blob => 0,  is_numeric => 0,  type => 'varchar(255)', default => ''},
289         Description => 
290                 {read => 1, write => 1, sql_type => 12, length => 255,  is_blob => 0,  is_numeric => 0,  type => 'varchar(255)', default => ''},
291         Content => 
292                 {read => 1, write => 1, sql_type => -4, length => 0,  is_blob => 1,  is_numeric => 0,  type => 'text', default => ''},
293         ContentType => 
294                 {read => 1, write => 1, sql_type => 12, length => 16,  is_blob => 0,  is_numeric => 0,  type => 'varchar(16)', default => ''},
295         ObjectType => 
296                 {read => 1, write => 1, sql_type => 12, length => 64,  is_blob => 0,  is_numeric => 0,  type => 'varchar(64)', default => ''},
297         ObjectId => 
298                 {read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => ''},
299         Creator => 
300                 {read => 1, auto => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
301         Created => 
302                 {read => 1, auto => 1, sql_type => 11, length => 0,  is_blob => 0,  is_numeric => 0,  type => 'datetime', default => ''},
303         LastUpdatedBy => 
304                 {read => 1, auto => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
305         LastUpdated => 
306                 {read => 1, auto => 1, sql_type => 11, length => 0,  is_blob => 0,  is_numeric => 0,  type => 'datetime', default => ''},
307
308  }
309 };
310
311
312         eval "require RT::Attribute_Overlay";
313         if ($@ && $@ !~ qr{^Can't locate RT/Attribute_Overlay.pm}) {
314             die $@;
315         };
316
317         eval "require RT::Attribute_Vendor";
318         if ($@ && $@ !~ qr{^Can't locate RT/Attribute_Vendor.pm}) {
319             die $@;
320         };
321
322         eval "require RT::Attribute_Local";
323         if ($@ && $@ !~ qr{^Can't locate RT/Attribute_Local.pm}) {
324             die $@;
325         };
326
327
328
329
330 =head1 SEE ALSO
331
332 This class allows "overlay" methods to be placed
333 into the following files _Overlay is for a System overlay by the original author,
334 _Vendor is for 3rd-party vendor add-ons, while _Local is for site-local customizations.  
335
336 These overlay files can contain new subs or subs to replace existing subs in this module.
337
338 Each of these files should begin with the line 
339
340    no warnings qw(redefine);
341
342 so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
343
344 RT::Attribute_Overlay, RT::Attribute_Vendor, RT::Attribute_Local
345
346 =cut
347
348
349 1;