Difference between revisions of "Freeside:3:Documentation:Developer/FS/cdr termination"

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_termination - Object methods for cdr_termination records
  
 +
==SYNOPSIS==
 +
<code>
 +
  use FS::cdr_termination;
 +
 +
  $record = new FS::cdr_termination \%hash;
 +
  $record = new FS::cdr_termination { 'column' => 'value' };
 +
 +
  $error = $record->insert;
 +
 +
  $error = $new_record->replace($old_record);
 +
 +
  $error = $record->delete;
 +
 +
  $error = $record->check;
 +
</code>
 +
==DESCRIPTION==
 +
An FS::cdr_termination object represents an CDR termination status. FS::cdr_termination inherits from FS::Record. The following fields are currently supported:
 +
 +
; cdrtermnum
 +
:primary key
 +
; acctid
 +
:acctid
 +
; termpart
 +
:termpart
 +
; rated_price
 +
:rated_price
 +
; status
 +
:status
 +
; svcnum
 +
:svc_phone record associated with this transaction, if there is one.
 +
 +
==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/cdr|FS::cdr]], [[Freeside:3:Documentation:Developer/FS/Record|FS::Record]], schema.html from the base documentation.

Latest revision as of 05:29, 10 February 2015

NAME

FS::cdr_termination - Object methods for cdr_termination records

SYNOPSIS

 use FS::cdr_termination;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::cdr_termination object represents an CDR termination status. FS::cdr_termination inherits from FS::Record. The following fields are currently supported:

cdrtermnum
primary key
acctid
acctid
termpart
termpart
rated_price
rated_price
status
status
svcnum
svc_phone record associated with this transaction, if there is one.

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::cdr, FS::Record, schema.html from the base documentation.

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