FS/FS/cust_note_class.pm

   1 package FS::cust_note_class;
   2 use base qw( FS::class_Common );
   3
   4 use strict;
   5
   6 =head1 NAME
   7
   8 FS::cust_note_class - Object methods for cust_note_class records
   9
  10 =head1 SYNOPSIS
  11
  12   use FS::cust_note_class;
  13
  14   $record = new FS::cust_note_class \%hash;
  15   $record = new FS::cust_note_class { 'column' => 'value' };
  16
  17   $error = $record->insert;
  18
  19   $error = $new_record->replace($old_record);
  20
  21   $error = $record->delete;
  22
  23   $error = $record->check;
  24
  25 =head1 DESCRIPTION
  26
  27 An FS::cust_note_class object represents a customer note class. Every customer
  28 note (see L<FS::cust_main_note) has, optionally, a note class. This class
  29 inherits from FS::class_Common.  The following fields are currently supported:
  30
  31 =over 4
  32
  33 =item classnum
  34
  35 primary key
  36
  37 =item classname
  38
  39 classname
  40
  41 =item disabled
  42
  43 disabled
  44
  45
  46 =back
  47
  48 =head1 METHODS
  49
  50 =over 4
  51
  52 =item new HASHREF
  53
  54 Creates a new customer note class.  To add the note class to the database,
  55 see L<"insert">.
  56
  57 Note that this stores the hash reference, not a distinct copy of the hash it
  58 points to.  You can ask the object for a copy with the I<hash> method.
  59
  60 =cut
  61
  62 sub table { 'cust_note_class'; }
  63 sub _target_table { 'cust_main_note'; }
  64
  65 =item insert
  66
  67 Adds this record to the database.  If there is an error, returns the error,
  68 otherwise returns false.
  69
  70 =cut
  71
  72 =item delete
  73
  74 Delete this record from the database.
  75
  76 =cut
  77
  78 =item replace OLD_RECORD
  79
  80 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  81 returns the error, otherwise returns false.
  82
  83 =cut
  84
  85 =item check
  86
  87 Checks all fields to make sure this is a valid note class.  If there is
  88 an error, returns the error, otherwise returns false.  Called by the insert
  89 and replace methods.
  90
  91 =cut
  92
  93 =back
  94
  95 =head1 BUGS
  96
  97 =head1 SEE ALSO
  98
  99 L<FS::cust_main_note>, L<FS::Record>, schema.html from the base documentation.
 100
 101 =cut
 102
 103 1;
 104