FS/FS/pkg_svc.pm

   1 package FS::pkg_svc;
   2 use base qw(FS::Record);
   3
   4 use strict;
   5
   6 =head1 NAME
   7
   8 FS::pkg_svc - Object methods for pkg_svc records
   9
  10 =head1 SYNOPSIS
  11
  12   use FS::pkg_svc;
  13
  14   $record = new FS::pkg_svc \%hash;
  15   $record = new FS::pkg_svc { '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   $part_pkg = $record->part_pkg;
  26
  27   $part_svc = $record->part_svc;
  28
  29 =head1 DESCRIPTION
  30
  31 An FS::pkg_svc record links a billing item definition (see L<FS::part_pkg>) to
  32 a service definition (see L<FS::part_svc>).  FS::pkg_svc inherits from
  33 FS::Record.  The following fields are currently supported:
  34
  35 =over 4
  36
  37 =item pkgsvcnum - primary key
  38
  39 =item pkgpart - Billing item definition (see L<FS::part_pkg>)
  40
  41 =item svcpart - Service definition (see L<FS::part_svc>)
  42
  43 =item quantity - Quantity of this service definition that this billing item
  44 definition includes
  45
  46 =item primary_svc - primary flag, empty or 'Y'
  47
  48 =item hidden - 'Y' to hide this service on invoices, null otherwise.
  49
  50 =back
  51
  52 =head1 METHODS
  53
  54 =over 4
  55
  56 =item new HASHREF
  57
  58 Create a new record.  To add the record to the database, see L<"insert">.
  59
  60 =cut
  61
  62 sub table { 'pkg_svc'; }
  63
  64 =item insert
  65
  66 Adds this record to the database.  If there is an error, returns the error,
  67 otherwise returns false.
  68
  69 =item delete
  70
  71 Deletes this record from the database.  If there is an error, returns the
  72 error, otherwise returns false.
  73
  74 =item replace OLD_RECORD
  75
  76 Replaces OLD_RECORD with this one in the database.  If there is an error,
  77 returns the error, otherwise returns false.
  78
  79 =cut
  80
  81 sub replace {
  82   my( $new, $old ) = ( shift, shift );
  83
  84   $old = $new->replace_old unless defined($old);
  85
  86   return "Can't change pkgpart!" if $old->pkgpart != $new->pkgpart;
  87   return "Can't change svcpart!" if $old->svcpart != $new->svcpart;
  88
  89   $new->SUPER::replace($old);
  90 }
  91
  92 =item check
  93
  94 Checks all fields to make sure this is a valid record.  If there is an error,
  95 returns the error, otherwise returns false.  Called by the insert and replace
  96 methods.
  97
  98 =cut
  99
 100 sub check {
 101   my $self = shift;
 102
 103   my $error;
 104   $error =
 105        $self->ut_numbern('pkgsvcnum')
 106     || $self->ut_number('pkgpart')
 107     || $self->ut_number('svcpart')
 108     || $self->ut_number('quantity')
 109     || $self->ut_enum('hidden', [ '', 'Y' ] )
 110   ;
 111   return $error if $error;
 112
 113   return "Unknown pkgpart!" unless $self->part_pkg;
 114   return "Unknown svcpart!" unless $self->part_svc;
 115
 116   if ( $self->dbdef_table->column('primary_svc') ) {
 117     $error = $self->ut_enum('primary_svc', [ '', 'Y' ] );
 118     return $error if $error;
 119   }
 120
 121   $self->SUPER::check;
 122 }
 123
 124 =item part_pkg
 125
 126 Returns the FS::part_pkg object (see L<FS::part_pkg>).
 127
 128 =item part_svc
 129
 130 Returns the FS::part_svc object (see L<FS::part_svc>).
 131
 132 =back
 133
 134 =head1 BUGS
 135
 136 =head1 SEE ALSO
 137
 138 L<FS::Record>, L<FS::part_pkg>, L<FS::part_svc>, schema.html from the base
 139 documentation.
 140
 141 =cut
 142
 143 1;
 144