FS/FS/svc_external.pm

   1 package FS::svc_external;
   2
   3 use strict;
   4 use vars qw(@ISA);
   5 use FS::Conf;
   6 use FS::svc_External_Common;
   7
   8 @ISA = qw( FS::svc_External_Common );
   9
  10 =head1 NAME
  11
  12 FS::svc_external - Object methods for svc_external records
  13
  14 =head1 SYNOPSIS
  15
  16   use FS::svc_external;
  17
  18   $record = new FS::svc_external \%hash;
  19   $record = new FS::svc_external { 'column' => 'value' };
  20
  21   $error = $record->insert;
  22
  23   $error = $new_record->replace($old_record);
  24
  25   $error = $record->delete;
  26
  27   $error = $record->check;
  28
  29   $error = $record->suspend;
  30
  31   $error = $record->unsuspend;
  32
  33   $error = $record->cancel;
  34
  35 =head1 DESCRIPTION
  36
  37 An FS::svc_external object represents a generic externally tracked service.
  38 FS::svc_external inherits from FS::svc_External_Common (and FS::svc_Common).
  39 The following fields are currently supported:
  40
  41 =over 4
  42
  43 =item svcnum - primary key
  44
  45 =item id - unique number of external record
  46
  47 =item title - for invoice line items
  48
  49 =back
  50
  51 =head1 METHODS
  52
  53 =over 4
  54
  55 =item new HASHREF
  56
  57 Creates a new external service.  To add the external service to the database,
  58 see L<"insert">.
  59
  60 Note that this stores the hash reference, not a distinct copy of the hash it
  61 points to.  You can ask the object for a copy with the I<hash> method.
  62
  63 =cut
  64
  65 sub table_info {
  66   {
  67     'name' => 'External service',
  68     'sorts' => 'id',
  69     'display_weight' => 90,
  70     'cancel_weight'  => 10,
  71     'fields' => {
  72     },
  73   };
  74 }
  75
  76 sub table { 'svc_external'; }
  77
  78 # oh!  this should be moved to svc_artera_turbo or something now
  79 sub label {
  80   my $self = shift;
  81   my $conf = new FS::Conf;
  82   if (    $conf->exists('svc_external-display_type')
  83        && $conf->config('svc_external-display_type') eq 'artera_turbo' )
  84   {
  85     sprintf('%010d', $self->id). '-'.
  86       substr('0000000000'.uc($self->title), -10);
  87   } else {
  88     $self->SUPER::label;
  89   }
  90 }
  91
  92 =item insert [ , OPTION => VALUE ... ]
  93
  94 Adds this external service to the database.  If there is an error, returns the
  95 error, otherwise returns false.
  96
  97 The additional fields pkgnum and svcpart (see L<FS::cust_svc>) should be
  98 defined.  An FS::cust_svc record will be created and inserted.
  99
 100 Currently available options are: I<depend_jobnum>
 101
 102 If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
 103 jobnums), all provisioning jobs will have a dependancy on the supplied
 104 jobnum(s) (they will not run until the specific job(s) complete(s)).
 105
 106 =cut
 107
 108 #sub insert {
 109 #  my $self = shift;
 110 #  my $error;
 111 #
 112 #  $error = $self->SUPER::insert(@_);
 113 #  return $error if $error;
 114 #
 115 #  '';
 116 #}
 117
 118 =item delete
 119
 120 Delete this record from the database.
 121
 122 =cut
 123
 124 #sub delete {
 125 #  my $self = shift;
 126 #  my $error;
 127 #
 128 #  $error = $self->SUPER::delete;
 129 #  return $error if $error;
 130 #
 131 #  '';
 132 #}
 133
 134
 135 =item replace OLD_RECORD
 136
 137 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 138 returns the error, otherwise returns false.
 139
 140 =cut
 141
 142 #sub replace {
 143 #  my ( $new, $old ) = ( shift, shift );
 144 #  my $error;
 145 #
 146 #  $error = $new->SUPER::replace($old);
 147 #  return $error if $error;
 148 #
 149 #  '';
 150 #}
 151
 152 =item suspend
 153
 154 Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
 155
 156 =item unsuspend
 157
 158 Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
 159
 160 =item cancel
 161
 162 Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
 163
 164 =item check
 165
 166 Checks all fields to make sure this is a valid external service.  If there is
 167 an error, returns the error, otherwise returns false.  Called by the insert
 168 and replace methods.
 169
 170 =cut
 171
 172 #sub check {
 173 #  my $self = shift;
 174 #  my $error;
 175 #
 176 #  $error = $self->SUPER::delete;
 177 #  return $error if $error;
 178 #
 179 #  '';
 180 #}
 181
 182 =back
 183
 184 =head1 BUGS
 185
 186 =head1 SEE ALSO
 187
 188 L<FS::svc_External_Common>, L<FS::svc_Common>, L<FS::Record>, L<FS::cust_svc>,
 189 L<FS::part_svc>, L<FS::cust_pkg>, schema.html from the base documentation.
 190
 191 =cut
 192
 193 1;
 194