1 package FS::cust_main_note;
4 use base qw( FS::otaker_Mixin FS::Record );
6 use FS::Record qw( qsearch qsearchs );
7 use FS::cust_note_class;
12 FS::cust_main_note - Object methods for cust_main_note records
16 use FS::cust_main_note;
18 $record = new FS::cust_main_note \%hash;
19 $record = new FS::cust_main_note { 'column' => 'value' };
21 $error = $record->insert;
23 $error = $new_record->replace($old_record);
25 $error = $record->delete;
27 $error = $record->check;
31 An FS::cust_main_note object represents a note attachted to a customer.
32 FS::cust_main_note inherits from FS::Record. The following fields are
59 Creates a new customer note. To add the note to the database, see L<"insert">.
61 Note that this stores the hash reference, not a distinct copy of the hash it
62 points to. You can ask the object for a copy with the I<hash> method.
66 # the new method can be inherited from FS::Record, if a table method is defined
68 sub table { 'cust_main_note'; }
72 Adds this record to the database. If there is an error, returns the error,
73 otherwise returns false.
77 # the insert method can be inherited from FS::Record
81 Delete this record from the database.
85 # the delete method can be inherited from FS::Record
87 =item replace OLD_RECORD
89 Replaces the OLD_RECORD with this one in the database. If there is an error,
90 returns the error, otherwise returns false.
94 # the replace method can be inherited from FS::Record
98 Checks all fields to make sure this is a valid example. If there is
99 an error, returns the error, otherwise returns false. Called by the insert
104 # the check method should currently be supplied - FS::Record contains some
105 # data checking routines
111 $self->ut_numbern('notenum')
112 || $self->ut_number('custnum')
113 || $self->ut_foreign_keyn('classnum', 'cust_note_class', 'classnum')
114 || $self->ut_numbern('_date')
115 || $self->ut_textn('otaker')
116 || $self->ut_anything('comments')
117 || $self->ut_numbern('sticky')
119 return $error if $error;
121 if (!$self->classnum) {
122 my $conf = new FS::Conf;
123 return 'Note class is required'
124 if $conf->exists('cust_main_note-require_class');
130 =item cust_note_class
132 Returns the customer note class, as an FS::cust_note_class object, or the empty
133 string if there is no note class.
137 sub cust_note_class {
139 if ( $self->classnum ) {
140 qsearchs('cust_note_class', { 'classnum' => $self->classnum } );
148 Returns the customer note class name, or the empty string if there is no
155 my $cust_note_class = $self->cust_note_class;
156 $cust_note_class ? $cust_note_class->classname : '';
160 #false laziness w/otaker_Mixin & cust_attachment
163 if ( scalar(@_) ) { #set
165 my($l,$f) = (split(', ', $otaker));
166 my $access_user = qsearchs('access_user', { 'username'=>$otaker } )
167 || qsearchs('access_user', { 'first'=>$f, 'last'=>$l } )
168 or croak "can't set otaker: $otaker not found!"; #confess?
169 $self->usernum( $access_user->usernum );
170 $otaker; #not sure return is used anywhere, but just in case
172 if ( $self->usernum ) {
173 $self->access_user->username;
174 } elsif ( length($self->get('otaker')) ) {
175 $self->get('otaker');
182 # Used by FS::Upgrade to migrate to a new database.
183 sub _upgrade_data { # class method
184 my ($class, %opts) = @_;
185 $class->_upgrade_otaker(%opts);
192 Lurking in the cracks.
196 L<FS::Record>, schema.html from the base documentation.