Difference between revisions of "Freeside:3:Documentation:Developer/FS/agent pkg class"

From Freeside
Jump to: navigation, search
m (Edit via perl MediaWiki framework (1.13))
m (Edit via perl MediaWiki framework (1.13))
 
Line 1: Line 1:
 +
==NAME==
 +
FS::agent_pkg_class - Object methods for agent_pkg_class records
  
 +
==SYNOPSIS==
 +
<code>
 +
  use FS::agent_pkg_class;
 +
 +
  $record = new FS::agent_pkg_class \%hash;
 +
  $record = new FS::agent_pkg_class { 'column' => 'value' };
 +
 +
  $error = $record->insert;
 +
 +
  $error = $new_record->replace($old_record);
 +
 +
  $error = $record->delete;
 +
 +
  $error = $record->check;
 +
</code>
 +
==DESCRIPTION==
 +
An FS::agent_pkg_class object represents a commission for a specific agent and package class. FS::agent_pkg_class inherits from FS::Record. The following fields are currently supported:
 +
 +
; agentpkgclassnum
 +
:primary key
 +
; agentnum
 +
:agentnum
 +
; classnum
 +
:classnum
 +
; commission_percent
 +
:commission_percent
 +
 +
==METHODS==
 +
; new HASHREF
 +
:Creates a new record. To add the record to the database, see [[#insert|"insert"]].
 +
 +
:Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the ''hash'' method.
 +
; insert
 +
:Adds this record to the database. If there is an error, returns the error, otherwise returns false.
 +
; delete
 +
:Delete this record from the database.
 +
; replace OLD_RECORD
 +
:Replaces the 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 record. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
 +
 +
==BUGS==
 +
==SEE ALSO==
 +
[[Freeside:3:Documentation:Developer/FS/agent|FS::agent]], [[Freeside:3:Documentation:Developer/FS/pkg class|FS::pkg_class]], [[Freeside:3:Documentation:Developer/FS/Record|FS::Record]].

Latest revision as of 05:28, 10 February 2015

NAME

FS::agent_pkg_class - Object methods for agent_pkg_class records

SYNOPSIS

 use FS::agent_pkg_class;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::agent_pkg_class object represents a commission for a specific agent and package class. FS::agent_pkg_class inherits from FS::Record. The following fields are currently supported:

agentpkgclassnum
primary key
agentnum
agentnum
classnum
classnum
commission_percent
commission_percent

METHODS

new HASHREF
Creates a new record. To add the record to the database, see "insert".
Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the hash method.
insert
Adds this record to the database. If there is an error, returns the error, otherwise returns false.
delete
Delete this record from the database.
replace OLD_RECORD
Replaces the 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 record. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

BUGS

SEE ALSO

FS::agent, FS::pkg_class, FS::Record.

Retrieved from "http://freeside.biz/mediawiki/index.php?title=Freeside:3:Documentation:Developer/FS/agent_pkg_class&oldid=8299"