From fadaa67e77ad8d5d966e252aba7f193e9e3840e3 Mon Sep 17 00:00:00 2001 From: ivan Date: Sat, 18 Feb 2006 11:14:21 +0000 Subject: CDR schema and class --- FS/FS/cdr_carrier.pm | 116 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 116 insertions(+) create mode 100644 FS/FS/cdr_carrier.pm (limited to 'FS/FS/cdr_carrier.pm') diff --git a/FS/FS/cdr_carrier.pm b/FS/FS/cdr_carrier.pm new file mode 100644 index 0000000..609c939 --- /dev/null +++ b/FS/FS/cdr_carrier.pm @@ -0,0 +1,116 @@ +package FS::cdr_carrier; + +use strict; +use vars qw( @ISA ); +use FS::Record qw( qsearch qsearchs ); + +@ISA = qw(FS::Record); + +=head1 NAME + +FS::cdr_carrier - Object methods for cdr_carrier records + +=head1 SYNOPSIS + + use FS::cdr_carrier; + + $record = new FS::cdr_carrier \%hash; + $record = new FS::cdr_carrier { 'column' => 'value' }; + + $error = $record->insert; + + $error = $new_record->replace($old_record); + + $error = $record->delete; + + $error = $record->check; + +=head1 DESCRIPTION + +An FS::cdr_carrier object represents an CDR carrier or upstream. +FS::cdr_carrier inherits from FS::Record. The following fields are currently +supported: + +=over 4 + +=item carrierid - primary key + +=item carriername - Carrier name + +=back + +=head1 METHODS + +=over 4 + +=item new HASHREF + +Creates a new carrier. To add the carrier to the database, see L<"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 I method. + +=cut + +# the new method can be inherited from FS::Record, if a table method is defined + +sub table { 'cdr_carrier'; } + +=item insert + +Adds this record to the database. If there is an error, returns the error, +otherwise returns false. + +=cut + +# the insert method can be inherited from FS::Record + +=item delete + +Delete this record from the database. + +=cut + +# the delete method can be inherited from FS::Record + +=item replace OLD_RECORD + +Replaces the OLD_RECORD with this one in the database. If there is an error, +returns the error, otherwise returns false. + +=cut + +# the replace method can be inherited from FS::Record + +=item check + +Checks all fields to make sure this is a valid carrier. If there is +an error, returns the error, otherwise returns false. Called by the insert +and replace methods. + +=cut + +sub check { + my $self = shift; + + my $error = + $self->ut_numbern('carrierid') + || $self->ut_text('carriername') + ; + return $error if $error; + + $self->SUPER::check; +} + +=back + +=head1 BUGS + +=head1 SEE ALSO + +L, schema.html from the base documentation. + +=cut + +1; + -- cgit v1.1