httemplate/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="#subroutines">SUBROUTINES</A></LI>
  19         <LI><A HREF="#version">VERSION</A></LI>
  20         <LI><A HREF="#bugs">BUGS</A></LI>
  21         <LI><A HREF="#see also">SEE ALSO</A></LI>
  22 </UL>
  23 <!-- INDEX END -->
  24
  25 <HR>
  26 <P>
  27 <H1><A NAME="name">NAME</A></H1>
  28 <P>FS::svc_acct_pop - Object methods for svc_acct_pop records</P>
  29 <P>
  30 <HR>
  31 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  32 <PRE>
  33   use FS::svc_acct_pop;</PRE>
  34 <PRE>
  35   $record = new FS::svc_acct_pop \%hash;
  36   $record = new FS::svc_acct_pop { 'column' =&gt; 'value' };</PRE>
  37 <PRE>
  38   $error = $record-&gt;insert;</PRE>
  39 <PRE>
  40   $error = $new_record-&gt;replace($old_record);</PRE>
  41 <PRE>
  42   $error = $record-&gt;delete;</PRE>
  43 <PRE>
  44   $error = $record-&gt;check;</PRE>
  45 <PRE>
  46   $html = FS::svc_acct_pop::popselector( $popnum, $state );</PRE>
  47 <P>
  48 <HR>
  49 <H1><A NAME="description">DESCRIPTION</A></H1>
  50 <P>An FS::svc_acct object represents an point of presence.  FS::svc_acct_pop
  51 inherits from FS::Record.  The following fields are currently supported:</P>
  52 <DL>
  53 <DT><STRONG><A NAME="item_key">popnum - primary key (assigned automatically for new accounts)</A></STRONG><BR>
  54 <DD>
  55 <DT><STRONG><A NAME="item_city">city</A></STRONG><BR>
  56 <DD>
  57 <DT><STRONG><A NAME="item_state">state</A></STRONG><BR>
  58 <DD>
  59 <DT><STRONG><A NAME="item_ac_%2D_area_code">ac - area code</A></STRONG><BR>
  60 <DD>
  61 <DT><STRONG><A NAME="item_exch_%2D_exchange">exch - exchange</A></STRONG><BR>
  62 <DD>
  63 <DT><STRONG><A NAME="item_loc_%2D_rest_of_number">loc - rest of number</A></STRONG><BR>
  64 <DD>
  65 </DL>
  66 <P>
  67 <HR>
  68 <H1><A NAME="methods">METHODS</A></H1>
  69 <DL>
  70 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><BR>
  71 <DD>
  72 Creates a new point of presence (if only it were that easy!).  To add the
  73 point of presence to the database, see <A HREF="#insert">insert</A>.
  74 <P></P>
  75 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR>
  76 <DD>
  77 Adds this point of presence to the database.  If there is an error, returns the
  78 error, otherwise returns false.
  79 <P></P>
  80 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR>
  81 <DD>
  82 Removes this point of presence from the database.
  83 <P></P>
  84 <DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR>
  85 <DD>
  86 Replaces OLD_RECORD with this one in the database.  If there is an error,
  87 returns the error, otherwise returns false.
  88 <P></P>
  89 <DT><STRONG><A NAME="item_check">check</A></STRONG><BR>
  90 <DD>
  91 Checks all fields to make sure this is a valid point of presence.  If there is
  92 an error, returns the error, otherwise returns false.  Called by the insert
  93 and replace methods.
  94 <P></P>
  95 <DT><STRONG><A NAME="item_text">text</A></STRONG><BR>
  96 <DD>
  97 Returns:
  98 <P>``$city, $state ($ac)/$exch''</P>
  99 <P></P></DL>
 100 <P>
 101 <HR>
 102 <H1><A NAME="subroutines">SUBROUTINES</A></H1>
 103 <DL>
 104 <DT><STRONG><A NAME="item_popselector_%5B_POPNUM_%5B_STATE_%5D_%5D">popselector [ POPNUM [ STATE ] ]</A></STRONG><BR>
 105 <DD>
 106 </DL>
 107 <P>
 108 <HR>
 109 <H1><A NAME="version">VERSION</A></H1>
 110 <P>$Id: svc_acct_pop.html,v 1.3 2002-01-29 17:42:46 ivan Exp $</P>
 111 <P>
 112 <HR>
 113 <H1><A NAME="bugs">BUGS</A></H1>
 114 <P>It should be renamed to part_pop.</P>
 115 <P>popselector?  putting web ui components in here?  they should probably live
 116 somewhere else...</P>
 117 <P>
 118 <HR>
 119 <H1><A NAME="see also">SEE ALSO</A></H1>
 120 <P><A HREF=".././FS/Record.html">the FS::Record manpage</A>, <A HREF=".././FS/svc_acct.html">the FS::svc_acct manpage</A>, <A HREF=".././FS/part_pop_local.html">the FS::part_pop_local manpage</A>, schema.html from the
 121 base documentation.</P>
 122
 123 </BODY>
 124
 125 </HTML>