FS/FS/pkg_svc.pm

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