X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=htdocs%2Fdocs%2Fman%2FFS%2Fagent.html;h=39d89a77033de4bdfa785241022ca5066c508176;hp=cb422fce727f2c26194fe0a8d17c7a7f2e28922f;hb=f3235d39d083518d47f21cd5585e5f9a13070763;hpb=ece31063b782031e21ba1f57476afab555af5363 diff --git a/htdocs/docs/man/FS/agent.html b/htdocs/docs/man/FS/agent.html index cb422fce7..39d89a770 100644 --- a/htdocs/docs/man/FS/agent.html +++ b/htdocs/docs/man/FS/agent.html @@ -1,129 +1,120 @@ FS::agent - Object methods for agent records - + +

NAME -
SYNOPSIS -
DESCRIPTION -
METHODS -
VERSION -
BUGS -
SEE ALSO +
NAME
SYNOPSIS
DESCRIPTION
METHODS
VERSION
BUGS
SEE ALSO

NAME

-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};
-

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: - +

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 FS::agent_type: -
prog - For future use.: -
freq - For future use.: +
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, +

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, +

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 FS::agent_type) for this agent. - -

pkgpart_hashref

-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. - -

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.2 2000-03-03 18:22:42 ivan Exp $ - +

VERSION

$Id: agent.html,v 1.3 2001-04-23 12:40:30 ivan Exp $