1 package FS::cust_main_note;
2 use base qw( FS::otaker_Mixin FS::Record );
6 use FS::Record qw( qsearchs ); #qw( qsearch qsearchs );
10 FS::cust_main_note - Object methods for cust_main_note records
14 use FS::cust_main_note;
16 $record = new FS::cust_main_note \%hash;
17 $record = new FS::cust_main_note { 'column' => 'value' };
19 $error = $record->insert;
21 $error = $new_record->replace($old_record);
23 $error = $record->delete;
25 $error = $record->check;
29 An FS::cust_main_note object represents a note attachted to a customer.
30 FS::cust_main_note inherits from FS::Record. The following fields are
57 Creates a new customer note. To add the note to the database, see L<"insert">.
59 Note that this stores the hash reference, not a distinct copy of the hash it
60 points to. You can ask the object for a copy with the I<hash> method.
64 # the new method can be inherited from FS::Record, if a table method is defined
66 sub table { 'cust_main_note'; }
70 Adds this record to the database. If there is an error, returns the error,
71 otherwise returns false.
75 # the insert method can be inherited from FS::Record
79 Delete this record from the database.
83 # the delete method can be inherited from FS::Record
85 =item replace OLD_RECORD
87 Replaces the OLD_RECORD with this one in the database. If there is an error,
88 returns the error, otherwise returns false.
92 # the replace method can be inherited from FS::Record
96 Checks all fields to make sure this is a valid example. If there is
97 an error, returns the error, otherwise returns false. Called by the insert
102 # the check method should currently be supplied - FS::Record contains some
103 # data checking routines
109 $self->ut_numbern('notenum')
110 || $self->ut_number('custnum')
111 || $self->ut_foreign_keyn('classnum', 'cust_note_class', 'classnum')
112 || $self->ut_numbern('_date')
113 || $self->ut_textn('otaker')
114 || $self->ut_anything('comments')
115 || $self->ut_numbern('sticky')
117 return $error if $error;
122 =item cust_note_class
124 Returns the customer note class, as an FS::cust_note_class object, or the empty
125 string if there is no note class.
129 Returns the customer note class name, or the empty string if there is no
136 my $cust_note_class = $self->cust_note_class;
137 $cust_note_class ? $cust_note_class->classname : '';
141 #false laziness w/otaker_Mixin & cust_attachment
144 if ( scalar(@_) ) { #set
146 my($l,$f) = (split(', ', $otaker));
147 my $access_user = qsearchs('access_user', { 'username'=>$otaker } )
148 || qsearchs('access_user', { 'first'=>$f, 'last'=>$l } )
149 or croak "can't set otaker: $otaker not found!"; #confess?
150 $self->usernum( $access_user->usernum );
151 $otaker; #not sure return is used anywhere, but just in case
153 if ( $self->usernum ) {
154 $self->access_user->username;
155 } elsif ( length($self->get('otaker')) ) {
156 $self->get('otaker');
163 # Used by FS::Upgrade to migrate to a new database.
164 sub _upgrade_data { # class method
165 my ($class, %opts) = @_;
166 $class->_upgrade_otaker(%opts);
173 Lurking in the cracks.
177 L<FS::Record>, schema.html from the base documentation.