1 package FS::cust_main_note;
4 use base qw( FS::otaker_Mixin FS::Record );
5 use FS::Record qw( qsearch qsearchs );
9 FS::cust_main_note - Object methods for cust_main_note records
13 use FS::cust_main_note;
15 $record = new FS::cust_main_note \%hash;
16 $record = new FS::cust_main_note { 'column' => 'value' };
18 $error = $record->insert;
20 $error = $new_record->replace($old_record);
22 $error = $record->delete;
24 $error = $record->check;
28 An FS::cust_main_note object represents a note attachted to a customer.
29 FS::cust_main_note inherits from FS::Record. The following fields are
54 Creates a new customer note. To add the note to the database, see L<"insert">.
56 Note that this stores the hash reference, not a distinct copy of the hash it
57 points to. You can ask the object for a copy with the I<hash> method.
61 # the new method can be inherited from FS::Record, if a table method is defined
63 sub table { 'cust_main_note'; }
67 Adds this record to the database. If there is an error, returns the error,
68 otherwise returns false.
72 # the insert method can be inherited from FS::Record
76 Delete this record from the database.
80 # the delete method can be inherited from FS::Record
82 =item replace OLD_RECORD
84 Replaces the OLD_RECORD with this one in the database. If there is an error,
85 returns the error, otherwise returns false.
89 # the replace method can be inherited from FS::Record
93 Checks all fields to make sure this is a valid example. If there is
94 an error, returns the error, otherwise returns false. Called by the insert
99 # the check method should currently be supplied - FS::Record contains some
100 # data checking routines
106 $self->ut_numbern('notenum')
107 || $self->ut_number('custnum')
108 || $self->ut_numbern('_date')
109 || $self->ut_textn('otaker')
110 || $self->ut_anything('comments')
112 return $error if $error;
117 # Used by FS::Upgrade to migrate to a new database.
118 sub _upgrade_data { # class method
119 my ($class, %opts) = @_;
120 $class->_upgrade_otaker(%opts);
127 Lurking in the cracks.
131 L<FS::Record>, schema.html from the base documentation.