summaryrefslogtreecommitdiff
path: root/FS/FS/svc_dish.pm
blob: 2d249d17f104e5f0e578c649b48667c40d1f21db (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
package FS::svc_dish;

use strict;
use base qw( FS::svc_Common );
use FS::Record qw( qsearch qsearchs );

=head1 NAME

FS::svc_dish - Object methods for svc_dish records

=head1 SYNOPSIS

  use FS::svc_dish;

  $record = new FS::svc_dish \%hash;
  $record = new FS::svc_dish { 'column' => 'value' };

  $error = $record->insert;

  $error = $new_record->replace($old_record);

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::svc_dish object represents a Dish Network service.  FS::svc_dish 
inherits from FS::svc_Common.

The following fields are currently supported:

=over 4

=item svcnum - Primary key

=item acctnum - DISH account number

=item installdate - Installation date (as Unix timestamp)

=item note - Installation notes: location on property, physical access, etc.

=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new svc_dish object.

=cut

sub table { 'svc_dish'; }

sub table_info {
  my %opts = ( 'type' => 'text', 
               'disable_select' => 1,
               'disable_inventory' => 1,
             );
  {
    'name'           => 'Dish service',
    'display_weight' => 58,
    'cancel_weight'  => 85,
    'manual_require' => 1,
    'fields' => {
      'svcnum'    =>  { label => 'Service' },
      'acctnum'   =>  { label => 'DISH account#', required => 1, %opts },
      'installdate' => { label => 'Install date', %opts },
      'note'      => { label => 'Installation notes', %opts },
    }
  }
}

sub label {
  my $self = shift;
  $self->acctnum;
}

sub search_sql {
  my($class, $string) = @_;
  $class->search_sql_field('acctnum', $string);
}

=item insert

Adds this record to the database.  If there is an error, returns the error,
otherwise returns false.

=item delete

Delete this record from the database.

=item replace OLD_RECORD

Replaces the OLD_RECORD with this one in the database.  If there is an error,
returns the error, otherwise returns false.

# the replace method can be inherited from FS::Record

=item check

Checks all fields to make sure this is a valid service.  If there is
an error, returns the error, otherwise returns false.  Called by the insert
and replace methods.

=cut

sub check {
  my $self = shift;

  my $x = $self->setfixed;
  return $x unless ref $x;

  my $error = 
    $self->ut_numbern('svcnum')
    || $self->ut_text('acctnum')
    || $self->ut_numbern('installdate')
    || $self->ut_anything('note')
  ;
  return $error if $error;

  $self->SUPER::check;
}

=back

=head1 SEE ALSO

L<FS::Record>, L<FS::svc_Common>, schema.html from the base documentation.

=cut

1;