FS/FS/export_svc.pm

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