FS/FS/did_order.pm

   1 package FS::did_order;
   2
   3 use strict;
   4 use base qw( FS::o2m_Common FS::Record );
   5 use FS::Record qw( qsearch qsearchs );
   6
   7 =head1 NAME
   8
   9 FS::did_order - Object methods for did_order records
  10
  11 =head1 SYNOPSIS
  12
  13   use FS::did_order;
  14
  15   $record = new FS::did_order \%hash;
  16   $record = new FS::did_order { '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 object represents a bulk DID order.  FS::did_order inherits from
  29 FS::Record.  The following fields are currently supported:
  30
  31 =over 4
  32
  33 =item ordernum
  34
  35 primary key
  36
  37 =item vendornum
  38
  39 vendornum
  40
  41 =item vendor_order_id
  42
  43 vendor_order_id
  44
  45 =item submitted
  46
  47 submitted
  48
  49 =item confirmed
  50
  51 confirmed
  52
  53 =item received
  54
  55 received
  56
  57
  58 =back
  59
  60 =head1 METHODS
  61
  62 =over 4
  63
  64 =item new HASHREF
  65
  66 Creates a new bulk DID order.  To add it to the database, see L<"insert">.
  67
  68 Note that this stores the hash reference, not a distinct copy of the hash it
  69 points to.  You can ask the object for a copy with the I<hash> method.
  70
  71 =cut
  72
  73 # the new method can be inherited from FS::Record, if a table method is defined
  74
  75 sub table { 'did_order'; }
  76
  77 =item insert
  78
  79 Adds this record to the database.  If there is an error, returns the error,
  80 otherwise returns false.
  81
  82 =cut
  83
  84 # the insert method can be inherited from FS::Record
  85
  86 =item delete
  87
  88 Delete this record from the database.
  89
  90 =cut
  91
  92 # the delete method can be inherited from FS::Record
  93
  94 =item replace OLD_RECORD
  95
  96 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  97 returns the error, otherwise returns false.
  98
  99 =cut
 100
 101 # the replace method can be inherited from FS::Record
 102
 103 =item check
 104
 105 Checks all fields to make sure this is a valid bulk DID order.  If there is
 106 an error, returns the error, otherwise returns false.  Called by the insert
 107 and replace methods.
 108
 109 =cut
 110
 111 # the check method should currently be supplied - FS::Record contains some
 112 # data checking routines
 113
 114 sub check {
 115   my $self = shift;
 116
 117   my $error =
 118     $self->ut_numbern('ordernum')
 119     || $self->ut_foreign_key('vendornum', 'did_vendor', 'vendornum' )
 120     || $self->ut_textn('vendor_order_id')
 121     || $self->ut_number('submitted')
 122     || $self->ut_numbern('confirmed')
 123     || $self->ut_numbern('received')
 124   ;
 125   return $error if $error;
 126
 127   $self->SUPER::check;
 128 }
 129
 130 =item did_order_item
 131
 132 Returns the did_order_items (see L<FS::did_order_item>) associated with this bulk DID order.
 133
 134 =cut
 135
 136 sub did_order_item {
 137   my $self = shift;
 138   qsearch( 'did_order_item', { 'ordernum' => $self->ordernum } );
 139 }
 140
 141 =item cust_main
 142
 143 Returns the cust_main (see L<FS::cust_main>), if any, associated with this bulk DID order.
 144
 145 =cut
 146
 147 sub cust_main {
 148   my $self = shift;
 149   return '' unless $self->custnum;
 150   qsearchs('cust_main', { 'custnum' => $self->custnum } );
 151 }
 152
 153 =back
 154
 155 =head1 SEE ALSO
 156
 157 L<FS::Record>, schema.html from the base documentation.
 158
 159 =cut
 160
 161 1;
 162