regenerated perl api docs from embedded pod
[freeside.git] / htdocs / docs / man / pkg_svc.txt
1 NAME
2     FS::pkg_svc - Object methods for pkg_svc records
3
4 SYNOPSIS
5       use FS::pkg_svc;
6
7       $record = new FS::pkg_svc \%hash;
8       $record = new FS::pkg_svc { 'column' => 'value' };
9
10       $error = $record->insert;
11
12       $error = $new_record->replace($old_record);
13
14       $error = $record->delete;
15
16       $error = $record->check;
17
18 DESCRIPTION
19     An FS::pkg_svc record links a billing item definition (see the
20     FS::part_pkg manpage) to a service definition (see the
21     FS::part_svc manpage). FS::pkg_svc inherits from FS::Record. The
22     following fields are currently supported:
23
24     pkgpart - Billing item definition (see the FS::part_pkg manpage)
25     svcpart - Service definition (see the FS::part_svc manpage)
26     quantity - Quantity of this service definition that this billing item
27     definition includes
28 METHODS
29     new HASHREF
30         Create a new record. To add the record to the database, see
31         the section on "insert".
32
33     insert
34         Adds this record to the database. If there is an error,
35         returns the error, otherwise returns false.
36
37     delete
38         Deletes this record from the database. If there is an error,
39         returns the error, otherwise returns false.
40
41     replace OLD_RECORD
42         Replaces OLD_RECORD with this one in the database. If there
43         is an error, returns the error, otherwise returns false.
44
45     check
46         Checks all fields to make sure this is a valid record. If
47         there is an error, returns the error, otherwise returns
48         false. Called by the insert and replace methods.
49
50 VERSION
51     $Id: pkg_svc.txt,v 1.3 1999-04-08 13:39:32 ivan Exp $
52
53 BUGS
54 SEE ALSO
55     the FS::Record manpage, the FS::part_pkg manpage, the
56     FS::part_svc manpage, schema.html from the base documentation.
57
58 HISTORY
59     ivan@voicenet.com 97-jul-1 added hfields ivan@sisd.com 97-nov-13
60
61     pod ivan@sisd.com 98-sep-22
62
63     $Log: pkg_svc.txt,v $
64     Revision 1.3  1999-04-08 13:39:32  ivan
65     convert from pod for 1.2.0 release
66  Revision 1.3 1999/01/18 21:58:08 ivan
67     esthetic: eq and ne were used in a few places instead of == and
68     !=
69
70     Revision 1.2 1998/12/29 11:59:51 ivan mostly properly OO, some
71     work still to be done with svc_ stuff
72