From 51984ac3d3da3006809c6866fdecd4ad83610731 Mon Sep 17 00:00:00 2001 From: ivan Date: Mon, 30 Jul 2001 07:36:04 +0000 Subject: templates!!! --- httemplate/docs/man/FS/agent.html | 121 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 121 insertions(+) create mode 100644 httemplate/docs/man/FS/agent.html (limited to 'httemplate/docs/man/FS/agent.html') 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 @@ + + +FS::agent - Object methods for agent records + + + + + + + + +

+ + +

NAME

FS::agent - Object methods for agent records

SYNOPSIS

+  use FS::agent;

+  $record = new FS::agent \%hash;
+  $record = new FS::agent { 'column' => 'value' };

+  $error = $record->insert;

+  $error = $new_record->replace($old_record);

+  $error = $record->delete;

+  $error = $record->check;

+  $agent_type = $record->agent_type;

+  $hashref = $record->pkgpart_hashref;
+  #may purchase $pkgpart if $hashref->{$pkgpart};

DESCRIPTION

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:

agemtnum - primary key (assigned automatically for new agents)
+: +
agent - Text name of this agent
+: +
typenum - Agent type. See the FS::agent_type manpage
+: +
prog - For future use.
+: +
freq - For future use.
+: +

METHODS

new HASHREF
+: +Creates a new agent. To add the agent to the database, see insert. +
+
insert
+: +Adds this agent to the database. If there is an error, returns the error, +otherwise returns false. +
+
delete
+: +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. +
+
replace OLD_RECORD
+: +Replaces OLD_RECORD with this one in the database. If there is an error, +returns the error, otherwise returns false. +
+
check
+: +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. +
+
agent_type
+: +Returns the FS::agent_type object (see the FS::agent_type manpage) for this agent. +
+
pkgpart_hashref
+: +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 +the FS::part_pkg manpage. +

VERSION

$Id: agent.html,v 1.3 2002-01-29 17:42:46 ivan Exp $

NAME

SYNOPSIS

DESCRIPTION

METHODS

VERSION

BUGS

SEE ALSO