htdocs/docs/man/FS/svc_acct_pop.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE>FS::svc_acct_pop - Object methods for svc_acct_pop records</TITLE>
   4 <LINK REV="made" HREF="mailto:perl@packages.debian.org">
   5 </HEAD>
   6
   7 <BODY>
   8
   9 <A NAME="__index__"></A>
  10 <!-- INDEX BEGIN -->
  11
  12 <UL>
  13
  14         <LI><A HREF="#name">NAME</A></LI>
  15         <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  16         <LI><A HREF="#description">DESCRIPTION</A></LI>
  17         <LI><A HREF="#methods">METHODS</A></LI>
  18         <LI><A HREF="#version">VERSION</A></LI>
  19         <LI><A HREF="#bugs">BUGS</A></LI>
  20         <LI><A HREF="#see also">SEE ALSO</A></LI>
  21 </UL>
  22 <!-- INDEX END -->
  23
  24 <HR>
  25 <P>
  26 <H1><A NAME="name">NAME</A></H1>
  27 <P>FS::svc_acct_pop - Object methods for svc_acct_pop records</P>
  28 <P>
  29 <HR>
  30 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  31 <PRE>
  32   use FS::svc_acct_pop;</PRE>
  33 <PRE>
  34   $record = new FS::svc_acct_pop \%hash;
  35   $record = new FS::svc_acct_pop { 'column' =&gt; 'value' };</PRE>
  36 <PRE>
  37   $error = $record-&gt;insert;</PRE>
  38 <PRE>
  39   $error = $new_record-&gt;replace($old_record);</PRE>
  40 <PRE>
  41   $error = $record-&gt;delete;</PRE>
  42 <PRE>
  43   $error = $record-&gt;check;</PRE>
  44 <P>
  45 <HR>
  46 <H1><A NAME="description">DESCRIPTION</A></H1>
  47 <P>An FS::svc_acct object represents an point of presence.  FS::svc_acct_pop
  48 inherits from FS::Record.  The following fields are currently supported:</P>
  49 <DL>
  50 <DT><STRONG><A NAME="item_key">popnum - primary key (assigned automatically for new accounts)</A></STRONG><BR>
  51 <DD>
  52 <DT><STRONG><A NAME="item_city">city</A></STRONG><BR>
  53 <DD>
  54 <DT><STRONG><A NAME="item_state">state</A></STRONG><BR>
  55 <DD>
  56 <DT><STRONG><A NAME="item_ac_%2D_area_code">ac - area code</A></STRONG><BR>
  57 <DD>
  58 <DT><STRONG><A NAME="item_exch_%2D_exchange">exch - exchange</A></STRONG><BR>
  59 <DD>
  60 <DT><STRONG><A NAME="item_loc_%2D_rest_of_number">loc - rest of number</A></STRONG><BR>
  61 <DD>
  62 </DL>
  63 <P>
  64 <HR>
  65 <H1><A NAME="methods">METHODS</A></H1>
  66 <DL>
  67 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><BR>
  68 <DD>
  69 Creates a new point of presence (if only it were that easy!).  To add the
  70 point of presence to the database, see <A HREF="#insert">insert</A>.
  71 <P></P>
  72 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR>
  73 <DD>
  74 Adds this point of presence to the database.  If there is an error, returns the
  75 error, otherwise returns false.
  76 <P></P>
  77 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR>
  78 <DD>
  79 Removes this point of presence from the database.
  80 <P></P>
  81 <DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR>
  82 <DD>
  83 Replaces OLD_RECORD with this one in the database.  If there is an error,
  84 returns the error, otherwise returns false.
  85 <P></P>
  86 <DT><STRONG><A NAME="item_check">check</A></STRONG><BR>
  87 <DD>
  88 Checks all fields to make sure this is a valid point of presence.  If there is
  89 an error, returns the error, otherwise returns false.  Called by the insert
  90 and replace methods.
  91 <P></P></DL>
  92 <P>
  93 <HR>
  94 <H1><A NAME="version">VERSION</A></H1>
  95 <P>$Id: svc_acct_pop.html,v 1.3 2001-04-23 12:40:31 ivan Exp $</P>
  96 <P>
  97 <HR>
  98 <H1><A NAME="bugs">BUGS</A></H1>
  99 <P>It should be renamed to part_pop.</P>
 100 <P>
 101 <HR>
 102 <H1><A NAME="see also">SEE ALSO</A></H1>
 103 <P><A HREF=".././FS/Record.html">the FS::Record manpage</A>, <A HREF=".././FS/svc_acct.html">the svc_acct manpage</A>, schema.html from the base documentation.</P>
 104
 105 </BODY>
 106
 107 </HTML>