summaryrefslogtreecommitdiff
path: root/FS/FS/export_cust_svc.pm
blob: 7cfdcc6a4d9c4ca1e5595d7987ff8705bb160042 (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
package FS::export_cust_svc;
use base qw(FS::Record);

use strict;
use FS::Record qw( qsearchs );

=head1 NAME

FS::export_cust_svc - Object methods for export_cust_svc records

=head1 SYNOPSIS

  use FS::export_cust_svc;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::export_cust_svc object represents information unique
to a given part_export and cust_svc pair.
FS::export_cust_svc inherits from FS::Record.  
The following fields are currently supported:

=over 4

=item exportcustsvcnum - primary key

=item exportnum - export (see L<FS::part_export>)

=item svcnum - service (see L<FS::cust_svc>)

=item remoteid - id for accessing service on export remote system

=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new export_cust_svc object.  To add the object to the database, see
L<"insert">.

Note that this stores the hash reference, not a distinct copy of the hash it
points to.  You can ask the object for a copy with the I<hash> method.

=cut

# the new method can be inherited from FS::Record, if a table method is defined

sub table { 'export_cust_svc'; }

=item insert

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

=cut

sub insert {
  my $self = shift;
  return "export_cust_svc for exportnum ".$self->exportnum.
         " svcnum ".$self->svcnum." already exists"
    if qsearchs('export_cust_svc',{ 'exportnum' => $self->exportnum,
                                    'svcnum'    => $self->svcnum });
  $self->SUPER::insert;
}

=item delete

Delete this record from the database.

=cut

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

=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.

=cut

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

=item check

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

=cut

# the check method should currently be supplied - FS::Record contains some
# data checking routines

sub check {
  my $self = shift;

  my $error = 
    $self->ut_numbern('exportcustsvcnum')
    || $self->ut_foreign_key('exportnum', 'part_export', 'exportnum')
    || $self->ut_foreign_key('svcnum', 'cust_svc', 'svcnum')
    || $self->ut_text('remoteid')
  ;
  return $error if $error;

  $self->SUPER::check;
}

=back

=head1 BUGS

Possibly.

=head1 SEE ALSO

L<FS::part_export>, L<FS::cust_svc>, L<FS::Record>

=cut

1;