Initial revision

[freeside.git] / htdocs / docs / man / agent_type.txt

diff --git a/htdocs/docs/man/agent_type.txt b/htdocs/docs/man/agent_type.txt
new file mode 100644 (file)
index 0000000..ea1edec
--- /dev/null
+++ b/htdocs/docs/man/agent_type.txt
@@ -0,0 +1,72 @@
+NAME
+    FS::agent_type - Object methods for agent_type records
+
+SYNOPSIS
+      use FS::agent_type;
+
+      $record = create FS::agent_type \%hash;
+      $record = create FS::agent_type { 'column' => 'value' };
+
+      $error = $record->insert;
+
+      $error = $new_record->replace($old_record);
+
+      $error = $record->delete;
+
+      $error = $record->check;
+
+DESCRIPTION
+    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:
+
+    typenum - primary key (assigned automatically for new agent types)
+    atype - Text name of this agent type
+METHODS
+    create HASHREF
+        Creates a new agent type. To add the agent type to the
+        database, see the section on "insert".
+
+    insert
+        Adds this agent type to the database. If there is an error,
+        returns the error, otherwise returns false.
+
+    delete
+        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 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 type.
+        If there is an error, returns the error, otherwise returns
+        false. Called by the insert and replace methods.
+
+BUGS
+    It doesn't properly override FS::Record yet.
+
+SEE ALSO
+    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.
+
+HISTORY
+    Class for the different sets of allowable packages you can
+    assign to an agent.
+
+    ivan@sisd.com 97-nov-13
+
+    ut_ FS::Record methods ivan@sisd.com 97-dec-10
+
+    Changed 'type' to 'atype' because Pg6.3 reserves the type word
+    bmccane@maxbaud.net 98-apr-3
+
+    pod, added check in delete ivan@sisd.com 98-sep-21
+