X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=htdocs%2Fdocs%2Fman%2FFS%2Fagent_type.html;fp=htdocs%2Fdocs%2Fman%2FFS%2Fagent_type.html;h=b34940752902d84d429549af907e9f68ede0d1c4;hp=d246bea3d599d1efb04298e8ba00056ee228704d;hb=f3235d39d083518d47f21cd5585e5f9a13070763;hpb=ece31063b782031e21ba1f57476afab555af5363 diff --git a/htdocs/docs/man/FS/agent_type.html b/htdocs/docs/man/FS/agent_type.html index d246bea3d..b34940752 100644 --- a/htdocs/docs/man/FS/agent_type.html +++ b/htdocs/docs/man/FS/agent_type.html @@ -1,137 +1,125 @@
-
-FS::agent_type - Object methods for agent_type records - +
FS::agent_type - Object methods for agent_type records
-
use FS::agent_type; --
-
$record = new FS::agent_type \%hash; - $record = new FS::agent_type { 'column' => 'value' }; --
-
$error = $record->insert; --
-
$error = $new_record->replace($old_record); --
-
$error = $record->delete; --
-
$error = $record->check; --
-
$hashref = $record->pkgpart_hashref; - #may purchase $pkgpart if $hashref->{$pkgpart}; --
-
@type_pkgs = $record->type_pkgs; --
-
@pkgparts = $record->pkgpart; -+
+ use FS::agent_type;+
+ $record = new FS::agent_type \%hash; + $record = new FS::agent_type { 'column' => 'value' };+
+ $error = $record->insert;+
+ $error = $new_record->replace($old_record);+
+ $error = $record->delete;+
+ $error = $record->check;+
+ $hashref = $record->pkgpart_hashref; + #may purchase $pkgpart if $hashref->{$pkgpart};+
+ @type_pkgs = $record->type_pkgs;+
+ @pkgparts = $record->pkgpart;
-An FS::agent_type object represents an agent type. Every agent (see -FS::agent) has an agent type. Agent types define which packages (see -FS::part_pkg) may be purchased by customers (see FS::cust_main), via FS::type_pkgs records (see FS::type_pkgs). FS::agent_type inherits from FS::Record. The following fields are -currently supported: - +
An FS::agent_type object represents an agent type. Every agent (see +the FS::agent manpage) has an agent type. Agent types define which packages (see +the FS::part_pkg manpage) may be purchased by customers (see the FS::cust_main manpage), via +FS::type_pkgs records (see the FS::type_pkgs manpage). FS::agent_type inherits from +FS::Record. The following fields are currently supported:
-Creates a new agent type. To add the agent type to the database, see +
-Adds this agent type to the database. If there is an error, returns the -error, otherwise returns false. - -
-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 +
+-Replaces OLD_RECORD with this one in the database. If there is an error, +
+-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 +
+-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 -FS::part_pkg. - -
-Returns all FS::type_pkgs objects (see FS::type_pkgs) for this agent type. - -
-Returns the pkgpart of all package definitions (see FS::part_pkg) for this agent type. - -
-$Id: agent_type.html,v 1.2 2000-03-03 18:22:42 ivan Exp $ - +
$Id: agent_type.html,v 1.3 2001-04-23 12:40:30 ivan Exp $
-FS::Record, FS::agent, FS::type_pkgs, FS::cust_main, -FS::part_pkg, schema.html from the base documentation. +
the FS::Record manpage, the FS::agent manpage, the FS::type_pkgs manpage, the FS::cust_main manpage, +the FS::part_pkg manpage, schema.html from the base documentation.