1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
package FS::cust_main_note;
use base qw( FS::otaker_Mixin FS::Record );
use strict;
use Carp;
use FS::Record qw( qsearchs ); #qw( qsearch qsearchs );
use FS::Conf;
=head1 NAME
FS::cust_main_note - Object methods for cust_main_note records
=head1 SYNOPSIS
use FS::cust_main_note;
$record = new FS::cust_main_note \%hash;
$record = new FS::cust_main_note { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::cust_main_note object represents a note attachted to a customer.
FS::cust_main_note inherits from FS::Record. The following fields are
currently supported:
=over 4
=item notenum
primary key
=item custnum
=item classnum
=item _date
=item usernum
=item comments
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new customer note. To add the note to the database, see L<"insert">.
Note that this stores the hash reference, not a distinct copy of the hash it
points to. You can ask the object for a copy with the I<hash> method.
=cut
# the new method can be inherited from FS::Record, if a table method is defined
sub table { 'cust_main_note'; }
=item insert
Adds this record to the database. If there is an error, returns the error,
otherwise returns false.
=cut
# the insert method can be inherited from FS::Record
=item delete
Delete this record from the database.
=cut
# the delete method can be inherited from FS::Record
=item replace OLD_RECORD
Replaces the OLD_RECORD with this one in the database. If there is an error,
returns the error, otherwise returns false.
=cut
# the replace method can be inherited from FS::Record
=item check
Checks all fields to make sure this is a valid example. If there is
an error, returns the error, otherwise returns false. Called by the insert
and replace methods.
=cut
# the check method should currently be supplied - FS::Record contains some
# data checking routines
sub check {
my $self = shift;
my $error =
$self->ut_numbern('notenum')
|| $self->ut_number('custnum')
|| $self->ut_foreign_keyn('classnum', 'cust_note_class', 'classnum')
|| $self->ut_numbern('_date')
|| $self->ut_textn('otaker')
|| $self->ut_anything('comments')
|| $self->ut_numbern('sticky')
;
return $error if $error;
if (!$self->classnum) {
my $conf = new FS::Conf;
return 'Note class is required'
if $conf->exists('cust_main_note-require_class');
}
$self->SUPER::check;
}
=item cust_note_class
Returns the customer note class, as an FS::cust_note_class object, or the empty
string if there is no note class.
=item classname
Returns the customer note class name, or the empty string if there is no
customer note class.
=cut
sub classname {
my $self = shift;
my $cust_note_class = $self->cust_note_class;
$cust_note_class ? $cust_note_class->classname : '';
}
#false laziness w/otaker_Mixin & cust_attachment
sub otaker {
my $self = shift;
if ( scalar(@_) ) { #set
my $otaker = shift;
my($l,$f) = (split(', ', $otaker));
my $access_user = qsearchs('access_user', { 'username'=>$otaker } )
|| qsearchs('access_user', { 'first'=>$f, 'last'=>$l } )
or croak "can't set otaker: $otaker not found!"; #confess?
$self->usernum( $access_user->usernum );
$otaker; #not sure return is used anywhere, but just in case
} else { #get
if ( $self->usernum ) {
$self->access_user->username;
} elsif ( length($self->get('otaker')) ) {
$self->get('otaker');
} else {
'';
}
}
}
# Used by FS::Upgrade to migrate to a new database.
sub _upgrade_data { # class method
my ($class, %opts) = @_;
$class->_upgrade_otaker(%opts);
}
=back
=head1 BUGS
Lurking in the cracks.
=head1 SEE ALSO
L<FS::Record>, schema.html from the base documentation.
=cut
1;
|
