removing
[freeside.git] / htdocs / docs / man / FS / agent_type.html
diff --git a/htdocs/docs/man/FS/agent_type.html b/htdocs/docs/man/FS/agent_type.html
deleted file mode 100644 (file)
index b349407..0000000
+++ /dev/null
@@ -1,126 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>FS::agent_type - Object methods for agent_type records</TITLE>
-<LINK REV="made" HREF="mailto:perl@packages.debian.org">
-</HEAD>
-
-<BODY>
-
-<A NAME="__index__"></A>
-<!-- INDEX BEGIN -->
-
-<UL>
-
-       <LI><A HREF="#name">NAME</A></LI>
-       <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
-       <LI><A HREF="#description">DESCRIPTION</A></LI>
-       <LI><A HREF="#methods">METHODS</A></LI>
-       <LI><A HREF="#version">VERSION</A></LI>
-       <LI><A HREF="#bugs">BUGS</A></LI>
-       <LI><A HREF="#see also">SEE ALSO</A></LI>
-</UL>
-<!-- INDEX END -->
-
-<HR>
-<P>
-<H1><A NAME="name">NAME</A></H1>
-<P>FS::agent_type - Object methods for agent_type records</P>
-<P>
-<HR>
-<H1><A NAME="synopsis">SYNOPSIS</A></H1>
-<PRE>
-  use FS::agent_type;</PRE>
-<PRE>
-  $record = new FS::agent_type \%hash;
-  $record = new FS::agent_type { 'column' =&gt; 'value' };</PRE>
-<PRE>
-  $error = $record-&gt;insert;</PRE>
-<PRE>
-  $error = $new_record-&gt;replace($old_record);</PRE>
-<PRE>
-  $error = $record-&gt;delete;</PRE>
-<PRE>
-  $error = $record-&gt;check;</PRE>
-<PRE>
-  $hashref = $record-&gt;pkgpart_hashref;
-  #may purchase $pkgpart if $hashref-&gt;{$pkgpart};</PRE>
-<PRE>
-  @type_pkgs = $record-&gt;type_pkgs;</PRE>
-<PRE>
-  @pkgparts = $record-&gt;pkgpart;</PRE>
-<P>
-<HR>
-<H1><A NAME="description">DESCRIPTION</A></H1>
-<P>An FS::agent_type object represents an agent type.  Every agent (see
-<A HREF=".././FS/agent.html">the FS::agent manpage</A>) has an agent type.  Agent types define which packages (see
-<A HREF=".././FS/part_pkg.html">the FS::part_pkg manpage</A>) may be purchased by customers (see <A HREF=".././FS/cust_main.html">the FS::cust_main manpage</A>), via 
-FS::type_pkgs records (see <A HREF=".././FS/type_pkgs.html">the FS::type_pkgs manpage</A>).  FS::agent_type inherits from
-FS::Record.  The following fields are currently supported:</P>
-<DL>
-<DT><STRONG><A NAME="item_key">typenum - primary key (assigned automatically for new agent types)</A></STRONG><BR>
-<DD>
-<DT><STRONG><A NAME="item_atype_%2D_Text_name_of_this_agent_type">atype - Text name of this agent type</A></STRONG><BR>
-<DD>
-</DL>
-<P>
-<HR>
-<H1><A NAME="methods">METHODS</A></H1>
-<DL>
-<DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><BR>
-<DD>
-Creates a new agent type.  To add the agent type to the database, see
-<A HREF="#insert">insert</A>.
-<P></P>
-<DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR>
-<DD>
-Adds this agent type to the database.  If there is an error, returns the error,
-otherwise returns false.
-<P></P>
-<DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR>
-<DD>
-Deletes this agent type from the database.  Only agent types with no agents
-can be deleted.  If there is an error, returns the error, otherwise returns
-false.
-<P></P>
-<DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR>
-<DD>
-Replaces OLD_RECORD with this one in the database.  If there is an error,
-returns the error, otherwise returns false.
-<P></P>
-<DT><STRONG><A NAME="item_check">check</A></STRONG><BR>
-<DD>
-Checks all fields to make sure this is a valid agent type.  If there is an
-error, returns the error, otherwise returns false.  Called by the insert and
-replace methods.
-<P></P>
-<DT><STRONG><A NAME="item_pkgpart_hashref">pkgpart_hashref</A></STRONG><BR>
-<DD>
-Returns a hash reference.  The keys of the hash are pkgparts.  The value is
-true iff this agent may purchase the specified package definition.  See
-<A HREF=".././FS/part_pkg.html">the FS::part_pkg manpage</A>.
-<P></P>
-<DT><STRONG><A NAME="item_type_pkgs">type_pkgs</A></STRONG><BR>
-<DD>
-Returns all FS::type_pkgs objects (see <A HREF=".././FS/type_pkgs.html">the FS::type_pkgs manpage</A>) for this agent type.
-<P></P>
-<DT><STRONG><A NAME="item_pkgpart">pkgpart</A></STRONG><BR>
-<DD>
-Returns the pkgpart of all package definitions (see <A HREF=".././FS/part_pkg.html">the FS::part_pkg manpage</A>) for this
-agent type.
-<P></P></DL>
-<P>
-<HR>
-<H1><A NAME="version">VERSION</A></H1>
-<P>$Id: agent_type.html,v 1.3 2001-04-23 12:40:30 ivan Exp $</P>
-<P>
-<HR>
-<H1><A NAME="bugs">BUGS</A></H1>
-<P>
-<HR>
-<H1><A NAME="see also">SEE ALSO</A></H1>
-<P><A HREF=".././FS/Record.html">the FS::Record manpage</A>, <A HREF=".././FS/agent.html">the FS::agent manpage</A>, <A HREF=".././FS/type_pkgs.html">the FS::type_pkgs manpage</A>, <A HREF=".././FS/cust_main.html">the FS::cust_main manpage</A>,
-<A HREF=".././FS/part_pkg.html">the FS::part_pkg manpage</A>, schema.html from the base documentation.</P>
-
-</BODY>
-
-</HTML>