Difference between revisions of "Freeside:3:Documentation:Developer/FS/cdr cust pkg usage"

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::cdr_cust_pkg_usage - Object methods for cdr_cust_pkg_usage records
  
 +
==SYNOPSIS==
 +
<code>
 +
  use FS::cdr_cust_pkg_usage;
 +
 +
  $record = new FS::cdr_cust_pkg_usage \%hash;
 +
  $record = new FS::cdr_cust_pkg_usage { 'column' => 'value' };
 +
 +
  $error = $record->insert;
 +
 +
  $error = $new_record->replace($old_record);
 +
 +
  $error = $record->delete;
 +
 +
  $error = $record->check;
 +
</code>
 +
==DESCRIPTION==
 +
An FS::cdr_cust_pkg_usage object represents an allocation of included usage minutes to a call. FS::cdr_cust_pkg_usage inherits from FS::Record. The following fields are currently supported:
 +
 +
; cdrusagenum - primary key; acctid - foreign key to cdr.acctid; pkgusagenum - foreign key to cust_pkg_usage.pkgusagenum; minutes - the number of minutes allocated
 +
==METHODS==
 +
; new HASHREF
 +
:Creates a new example. To add the example 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 example. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
 +
; cust_pkg_usage
 +
:Returns the [[Freeside:3:Documentation:Developer/FS/cust pkg usage|FS::cust_pkg_usage]] object that this usage allocation came from.
 +
; cdr
 +
:Returns the [[Freeside:3:Documentation:Developer/FS/cdr|FS::cdr]] object that the usage was applied to.
 +
 +
==SEE ALSO==
 +
[[Freeside:3:Documentation:Developer/FS/Record|FS::Record]], schema.html from the base documentation.

Latest revision as of 06:29, 10 February 2015

NAME

FS::cdr_cust_pkg_usage - Object methods for cdr_cust_pkg_usage records

SYNOPSIS

 use FS::cdr_cust_pkg_usage;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::cdr_cust_pkg_usage object represents an allocation of included usage minutes to a call. FS::cdr_cust_pkg_usage inherits from FS::Record. The following fields are currently supported:

cdrusagenum - primary key; acctid - foreign key to cdr.acctid; pkgusagenum - foreign key to cust_pkg_usage.pkgusagenum; minutes - the number of minutes allocated

METHODS

new HASHREF
Creates a new example. To add the example 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 example. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
cust_pkg_usage
Returns the FS::cust_pkg_usage object that this usage allocation came from.
cdr
Returns the FS::cdr object that the usage was applied to.

SEE ALSO

FS::Record, schema.html from the base documentation.

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