fix order_pkg-no_start_date option, RT#25650, fallout from RT#24955, fallout from...
[freeside.git] / FS / FS / part_pkg_link.pm
1 package FS::part_pkg_link;
2
3 use strict;
4 use vars qw( @ISA );
5 use FS::Record qw( qsearchs );
6 use FS::part_pkg;
7
8 @ISA = qw(FS::Record);
9
10 =head1 NAME
11
12 FS::part_pkg_link - Object methods for part_pkg_link records
13
14 =head1 SYNOPSIS
15
16   use FS::part_pkg_link;
17
18   $record = new FS::part_pkg_link \%hash;
19   $record = new FS::part_pkg_link { '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 =head1 DESCRIPTION
30
31 An FS::part_pkg_link object represents an link from one package definition to
32 another.  FS::part_pkg_link inherits from FS::Record.  The following fields are
33 currently supported:
34
35 =over 4
36
37 =item pkglinknum
38
39 primary key
40
41 =item src_pkgpart
42
43 Source package (see L<FS::part_pkg>)
44
45 =item dst_pkgpart
46
47 Destination package (see L<FS::part_pkg>)
48
49 =item link_type
50
51 Link type - currently, "bill" (source package bills a line item from target
52 package), or "svc" (source package includes services from target package).
53
54 =item hidden
55
56 Flag indicating that this subpackage should be felt, but not seen as an invoice
57 line item when set to 'Y'
58
59 =back
60
61 =head1 METHODS
62
63 =over 4
64
65 =item new HASHREF
66
67 Creates a new link.  To add the link to the database, see L<"insert">.
68
69 Note that this stores the hash reference, not a distinct copy of the hash it
70 points to.  You can ask the object for a copy with the I<hash> method.
71
72 =cut
73
74 # the new method can be inherited from FS::Record, if a table method is defined
75
76 sub table { 'part_pkg_link'; }
77
78 =item insert
79
80 Adds this record to the database.  If there is an error, returns the error,
81 otherwise returns false.
82
83 =cut
84
85 # the insert method can be inherited from FS::Record
86
87 =item delete
88
89 Delete this record from the database.
90
91 =cut
92
93 # the delete method can be inherited from FS::Record
94
95 =item replace OLD_RECORD
96
97 Replaces the OLD_RECORD with this one in the database.  If there is an error,
98 returns the error, otherwise returns false.
99
100 =cut
101
102 # the replace method can be inherited from FS::Record
103
104 =item check
105
106 Checks all fields to make sure this is a valid link.  If there is
107 an error, returns the error, otherwise returns false.  Called by the insert
108 and replace methods.
109
110 =cut
111
112 # the check method should currently be supplied - FS::Record contains some
113 # data checking routines
114
115 sub check {
116   my $self = shift;
117
118   my $error = 
119     $self->ut_numbern('pkglinknum')
120     || $self->ut_foreign_key('src_pkgpart', 'part_pkg', 'pkgpart')
121     || $self->ut_foreign_key('dst_pkgpart', 'part_pkg', 'pkgpart')
122     || $self->ut_enum('link_type', [ 'bill', 'svc' ] )
123     || $self->ut_enum('hidden', [ '', 'Y' ] )
124   ;
125   return $error if $error;
126
127   $self->SUPER::check;
128 }
129
130 =item src_pkg
131
132 Returns the source part_pkg object (see L<FS::part_pkg>).
133
134 =cut
135
136 sub src_pkg {
137   my $self = shift;
138   qsearchs('part_pkg', { 'pkgpart' => $self->src_pkgpart } );
139 }
140
141 =item dst_pkg
142
143 Returns the source part_pkg object (see L<FS::part_pkg>).
144
145 =cut
146
147 sub dst_pkg {
148   my $self = shift;
149   qsearchs('part_pkg', { 'pkgpart' => $self->dst_pkgpart } );
150 }
151
152 =back
153
154 =head1 BUGS
155
156 =head1 SEE ALSO
157
158 L<FS::Record>, schema.html from the base documentation.
159
160 =cut
161
162 1;
163