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