htdocs/docs/man/FS/part_svc.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE>FS::part_svc - Object methods for part_svc objects</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::part_svc - Object methods for part_svc objects</P>
  28 <P>
  29 <HR>
  30 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  31 <PRE>
  32   use FS::part_svc;</PRE>
  33 <PRE>
  34   $record = new FS::part_referral \%hash
  35   $record = new FS::part_referral { '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::part_svc represents a service definition.  FS::part_svc inherits from
  48 FS::Record.  The following fields are currently supported:</P>
  49 <DL>
  50 <DT><STRONG><A NAME="item_key">svcpart - primary key (assigned automatically for new service definitions)</A></STRONG><BR>
  51 <DD>
  52 <DT><STRONG><A NAME="item_svc_%2D_text_name_of_this_service_definition">svc - text name of this service definition</A></STRONG><BR>
  53 <DD>
  54 <DT><STRONG><A NAME="item_svcdb_%2D_table_used_for_this_service%2E_See_FS%3A">svcdb - table used for this service.  See <A HREF=".././FS/svc_acct.html">the FS::svc_acct manpage</A>,
  55 <A HREF=".././FS/svc_domain.html">the FS::svc_domain manpage</A>, and <A HREF=".././FS/svc_acct_sm.html">the FS::svc_acct_sm manpage</A>, among others.</A></STRONG><BR>
  56 <DD>
  57 <DT><STRONG><A NAME="item_svcdb__field_%2D_Default_or_fixed_value_for_field_"><EM>svcdb</EM>__<EM>field</EM> - Default or fixed value for <EM>field</EM> in <EM>svcdb</EM>.</A></STRONG><BR>
  58 <DD>
  59 <DT><STRONG><A NAME="item_svcdb__field_flag_%2D_defines_svcdb__field_action%"><EM>svcdb</EM>__<EM>field</EM>_flag - defines <EM>svcdb</EM>__<EM>field</EM> action: null, `D' for default, or `F' for fixed</A></STRONG><BR>
  60 <DD>
  61 </DL>
  62 <P>
  63 <HR>
  64 <H1><A NAME="methods">METHODS</A></H1>
  65 <DL>
  66 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><BR>
  67 <DD>
  68 Creates a new service definition.  To add the service definition to the
  69 database, see <A HREF="#insert">insert</A>.
  70 <P></P>
  71 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR>
  72 <DD>
  73 Adds this service definition to the database.  If there is an error, returns
  74 the error, otherwise returns false.
  75 <P></P>
  76 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR>
  77 <DD>
  78 Currently unimplemented.
  79 <P></P>
  80 <DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR>
  81 <DD>
  82 Replaces OLD_RECORD with this one in the database.  If there is an error,
  83 returns the error, otherwise returns false.
  84 <P></P>
  85 <DT><STRONG><A NAME="item_check">check</A></STRONG><BR>
  86 <DD>
  87 Checks all fields to make sure this is a valid service definition.  If there is
  88 an error, returns the error, otherwise returns false.  Called by the insert
  89 and replace methods.
  90 <P></P></DL>
  91 <P>
  92 <HR>
  93 <H1><A NAME="version">VERSION</A></H1>
  94 <P>$Id: part_svc.html,v 1.3 2001-04-23 12:40:31 ivan Exp $</P>
  95 <P>
  96 <HR>
  97 <H1><A NAME="bugs">BUGS</A></H1>
  98 <P>Delete is unimplemented.</P>
  99 <P>The list of svc_* tables is hardcoded.  When svc_acct_pop is renamed, this
 100 should be fixed.</P>
 101 <P>
 102 <HR>
 103 <H1><A NAME="see also">SEE ALSO</A></H1>
 104 <P><A HREF=".././FS/Record.html">the FS::Record manpage</A>, <A HREF=".././FS/part_pkg.html">the FS::part_pkg manpage</A>, <A HREF=".././FS/pkg_svc.html">the FS::pkg_svc manpage</A>, <A HREF=".././FS/cust_svc.html">the FS::cust_svc manpage</A>,
 105 <A HREF=".././FS/svc_acct.html">the FS::svc_acct manpage</A>, <A HREF=".././FS/svc_acct_sm.html">the FS::svc_acct_sm manpage</A>, <A HREF=".././FS/svc_domain.html">the FS::svc_domain manpage</A>, schema.html from the
 106 base documentation.</P>
 107
 108 </BODY>
 109
 110 </HTML>