From 1d758388ce3b17b8de1ae1d3a8ec39c1026baefc Mon Sep 17 00:00:00 2001 From: ivan Date: Mon, 13 Aug 2001 01:09:02 +0000 Subject: removing --- htdocs/docs/man/FS/agent.html | 121 ------------------------------------------ 1 file changed, 121 deletions(-) delete mode 100644 htdocs/docs/man/FS/agent.html (limited to 'htdocs/docs/man/FS/agent.html') diff --git a/htdocs/docs/man/FS/agent.html b/htdocs/docs/man/FS/agent.html deleted file mode 100644 index 39d89a770..000000000 --- a/htdocs/docs/man/FS/agent.html +++ /dev/null @@ -1,121 +0,0 @@ - - -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 2001-04-23 12:40:30 ivan Exp $

-

-

-

BUGS

-

-

-

SEE ALSO

-

the FS::Record manpage, the FS::agent_type manpage, the FS::cust_main manpage, the FS::part_pkg manpage, -schema.html from the base documentation.

- - - - -- cgit v1.2.1