FS/FS/did_order_item.pm

   1 package FS::did_order_item;
   2
   3 use strict;
   4 use base qw( FS::Record );
   5 use FS::Record qw( qsearch qsearchs );
   6
   7 =head1 NAME
   8
   9 FS::did_order_item - Object methods for did_order_item records
  10
  11 =head1 SYNOPSIS
  12
  13   use FS::did_order_item;
  14
  15   $record = new FS::did_order_item \%hash;
  16   $record = new FS::did_order_item { 'column' => 'value' };
  17
  18   $error = $record->insert;
  19
  20   $error = $new_record->replace($old_record);
  21
  22   $error = $record->delete;
  23
  24   $error = $record->check;
  25
  26 =head1 DESCRIPTION
  27
  28 An FS::did_order_item object represents an item in a bulk DID order.
  29 FS::did_order_item inherits from FS::Record.
  30 The following fields are currently supported:
  31
  32 =over 4
  33
  34 =item orderitemnum
  35
  36 primary key
  37
  38 =item ordernum
  39
  40 =item msanum - foreign key to msa table
  41
  42 =item npa
  43
  44 =item latanum - foreign key to lata table
  45
  46 =item ratecenternum - foreign key to rate_center table
  47
  48 =item state
  49
  50 =item quantity
  51
  52 =back
  53
  54 =head1 METHODS
  55
  56 =over 4
  57
  58 =item new HASHREF
  59
  60 Creates a new DID order item.  To add it to the database, see L<"insert">.
  61
  62 Note that this stores the hash reference, not a distinct copy of the hash it
  63 points to.  You can ask the object for a copy with the I<hash> method.
  64
  65 =cut
  66
  67 # the new method can be inherited from FS::Record, if a table method is defined
  68
  69 sub table { 'did_order_item'; }
  70
  71 =item insert
  72
  73 Adds this record to the database.  If there is an error, returns the error,
  74 otherwise returns false.
  75
  76 =cut
  77
  78 # the insert method can be inherited from FS::Record
  79
  80 =item delete
  81
  82 Delete this record from the database.
  83
  84 =cut
  85
  86 # the delete method can be inherited from FS::Record
  87
  88 =item replace OLD_RECORD
  89
  90 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  91 returns the error, otherwise returns false.
  92
  93 =cut
  94
  95 # the replace method can be inherited from FS::Record
  96
  97 =item check
  98
  99 Checks all fields to make sure this is a valid DID order item.  If there is
 100 an error, returns the error, otherwise returns false.  Called by the insert
 101 and replace methods.
 102
 103 =cut
 104
 105 # the check method should currently be supplied - FS::Record contains some
 106 # data checking routines
 107
 108 sub check {
 109   my $self = shift;
 110
 111   my $error =
 112     $self->ut_numbern('orderitemnum')
 113     || $self->ut_number('ordernum')
 114     || $self->ut_foreign_keyn('msanum', 'msa', 'msanum')
 115     || $self->ut_numbern('npa')
 116     || $self->ut_foreign_keyn('latanum', 'lata', 'latanum')
 117     || $self->ut_foreign_keyn('ratecenternum', 'rate_center', 'ratecenternum')
 118     || $self->ut_textn('state')
 119     || $self->ut_number('quantity')
 120   ;
 121   return $error if $error;
 122
 123   $self->SUPER::check;
 124 }
 125
 126 =back
 127
 128 =head1 SEE ALSO
 129
 130 L<FS::Record>, schema.html from the base documentation.
 131
 132 =cut
 133
 134 1;
 135