diff options
| author | ivan <ivan> | 2001-07-30 07:36:04 +0000 |
|---|---|---|
| committer | ivan <ivan> | 2001-07-30 07:36:04 +0000 |
| commit | 51984ac3d3da3006809c6866fdecd4ad83610731 (patch) | |
| tree | ac16f533c25a1947eee7bee226fed5638c42bd94 /httemplate/docs/man/FS/agent.html | |
| parent | 9c2016b3a564d439960420114ce6f4cab3bf723b (diff) | |
templates!!!
Diffstat (limited to 'httemplate/docs/man/FS/agent.html')
| -rw-r--r-- | httemplate/docs/man/FS/agent.html | 121 |
1 files changed, 121 insertions, 0 deletions
diff --git a/httemplate/docs/man/FS/agent.html b/httemplate/docs/man/FS/agent.html new file mode 100644 index 000000000..a660ed427 --- /dev/null +++ b/httemplate/docs/man/FS/agent.html @@ -0,0 +1,121 @@ +<HTML> +<HEAD> +<TITLE>FS::agent - Object methods for agent 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 - Object methods for agent records</P> +<P> +<HR> +<H1><A NAME="synopsis">SYNOPSIS</A></H1> +<PRE> + use FS::agent;</PRE> +<PRE> + $record = new FS::agent \%hash; + $record = new FS::agent { 'column' => 'value' };</PRE> +<PRE> + $error = $record->insert;</PRE> +<PRE> + $error = $new_record->replace($old_record);</PRE> +<PRE> + $error = $record->delete;</PRE> +<PRE> + $error = $record->check;</PRE> +<PRE> + $agent_type = $record->agent_type;</PRE> +<PRE> + $hashref = $record->pkgpart_hashref; + #may purchase $pkgpart if $hashref->{$pkgpart};</PRE> +<P> +<HR> +<H1><A NAME="description">DESCRIPTION</A></H1> +<P>An FS::agent object represents an agent. Every customer has an agent. Agents +can be used to track things like resellers or salespeople. FS::agent inherits +from FS::Record. The following fields are currently supported:</P> +<DL> +<DT><STRONG><A NAME="item_key">agemtnum - primary key (assigned automatically for new agents)</A></STRONG><BR> +<DD> +<DT><STRONG><A NAME="item_agent_%2D_Text_name_of_this_agent">agent - Text name of this agent</A></STRONG><BR> +<DD> +<DT><STRONG><A NAME="item_typenum_%2D_Agent_type%2E_See_FS%3A%3Aagent_type">typenum - Agent type. See <A HREF=".././FS/agent_type.html">the FS::agent_type manpage</A></A></STRONG><BR> +<DD> +<DT><STRONG><A NAME="item_prog_%2D_For_future_use%2E">prog - For future use.</A></STRONG><BR> +<DD> +<DT><STRONG><A NAME="item_freq_%2D_For_future_use%2E">freq - For future use.</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. To add the agent 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 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 from the database. Only agents with no customers 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. 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_agent_type">agent_type</A></STRONG><BR> +<DD> +Returns the FS::agent_type object (see <A HREF=".././FS/agent_type.html">the FS::agent_type manpage</A>) for this agent. +<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 if this agent may purchase the specified package definition. See +<A HREF=".././FS/part_pkg.html">the FS::part_pkg manpage</A>. +<P></P></DL> +<P> +<HR> +<H1><A NAME="version">VERSION</A></H1> +<P>$Id: agent.html,v 1.3 2002-01-29 17:42:46 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_type.html">the FS::agent_type 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> |