Initial revision
[freeside.git] / htdocs / docs / man / svc_acct_pop.txt
1 NAME
2     FS::svc_acct_pop - Object methods for svc_acct_pop records
3
4 SYNOPSIS
5       use FS::svc_acct_pop;
6
7       $record = create FS::svc_acct_pop \%hash;
8       $record = create FS::svc_acct_pop { '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::svc_acct object represents an point of presence.
20     FS::svc_acct_pop inherits from FS::Record. The following fields
21     are currently supported:
22
23     popnum - primary key (assigned automatically for new accounts)
24     city
25     state
26     ac - area code
27     exch - exchange
28 METHODS
29     create HASHREF
30         Creates a new point of presence (if only it were that
31         easy!). To add the point of presence to the database, see
32         the section on "insert".
33
34     insert
35         Adds this point of presence to the databaes. If there is an
36         error, returns the error, otherwise returns false.
37
38     delete
39         Currently unimplemented.
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 point of
47         presence. If there is an error, returns the error, otherwise
48         returns false. Called by the insert and replace methods.
49
50 BUGS
51     It doesn't properly override FS::Record yet.
52
53     It should be renamed to part_pop.
54
55 SEE ALSO
56     the FS::Record manpage, the svc_acct manpage, schema.html from
57     the base documentation.
58
59 HISTORY
60     Class dealing with pops
61
62     ivan@sisd.com 98-mar-8
63
64     pod ivan@sisd.com 98-sep-23
65