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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
package FS::part_pkg_link;
use strict;
use vars qw( @ISA );
use FS::Record qw( qsearchs );
use FS::part_pkg;
@ISA = qw(FS::Record);
=head1 NAME
FS::part_pkg_link - Object methods for part_pkg_link records
=head1 SYNOPSIS
use FS::part_pkg_link;
$record = new FS::part_pkg_link \%hash;
$record = new FS::part_pkg_link { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::part_pkg_link object represents an link from one package definition to
another. FS::part_pkg_link inherits from FS::Record. The following fields are
currently supported:
=over 4
=item pkglinknum
primary key
=item src_pkgpart
Source package (see L<FS::part_pkg>)
=item dst_pkgpart
Destination package (see L<FS::part_pkg>)
=item link_type
Link type - currently, "bill" (source package bills a line item from target
package), or "svc" (source package includes services from target package).
=item hidden
Flag indicating that this subpackage should be felt, but not seen as an invoice
line item when set to 'Y'
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new link. To add the link 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 { 'part_pkg_link'; }
=item insert
Adds this record to the database. If there is an error, returns the error,
otherwise returns false.
=cut
# the insert method can be inherited from FS::Record
=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 link. 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('pkglinknum')
|| $self->ut_foreign_key('src_pkgpart', 'part_pkg', 'pkgpart')
|| $self->ut_foreign_key('dst_pkgpart', 'part_pkg', 'pkgpart')
|| $self->ut_enum('link_type', [ 'bill', 'svc' ] )
|| $self->ut_enum('hidden', [ '', 'Y' ] )
;
return $error if $error;
$self->SUPER::check;
}
=item src_pkg
Returns the source part_pkg object (see L<FS::part_pkg>).
=cut
sub src_pkg {
my $self = shift;
qsearchs('part_pkg', { 'pkgpart' => $self->src_pkgpart } );
}
=item dst_pkg
Returns the source part_pkg object (see L<FS::part_pkg>).
=cut
sub dst_pkg {
my $self = shift;
qsearchs('part_pkg', { 'pkgpart' => $self->dst_pkgpart } );
}
=back
=head1 BUGS
=head1 SEE ALSO
L<FS::Record>, schema.html from the base documentation.
=cut
1;
|
