diff options
author | ivan <ivan> | 2006-02-18 11:14:21 +0000 |
---|---|---|
committer | ivan <ivan> | 2006-02-18 11:14:21 +0000 |
commit | fadaa67e77ad8d5d966e252aba7f193e9e3840e3 (patch) | |
tree | 8f425d82a445dd5ba6ed58f316e4b7a6802ef2dc /FS/FS/cdr_type.pm | |
parent | 6d27649c93f3f83c14611c790281a7b667062fc0 (diff) |
CDR schema and class
Diffstat (limited to 'FS/FS/cdr_type.pm')
-rw-r--r-- | FS/FS/cdr_type.pm | 119 |
1 files changed, 119 insertions, 0 deletions
diff --git a/FS/FS/cdr_type.pm b/FS/FS/cdr_type.pm new file mode 100644 index 000000000..e258bf878 --- /dev/null +++ b/FS/FS/cdr_type.pm @@ -0,0 +1,119 @@ +package FS::cdr_type; + +use strict; +use vars qw( @ISA ); +use FS::Record qw( qsearch qsearchs ); + +@ISA = qw(FS::Record); + +=head1 NAME + +FS::cdr_type - Object methods for cdr_type records + +=head1 SYNOPSIS + + use FS::cdr_type; + + $record = new FS::cdr_type \%hash; + $record = new FS::cdr_type { 'column' => 'value' }; + + $error = $record->insert; + + $error = $new_record->replace($old_record); + + $error = $record->delete; + + $error = $record->check; + +=head1 DESCRIPTION + +An FS::cdr_type object represents an CDR type. FS::cdr_type inherits from +FS::Record. The following fields are currently supported: + +=over 4 + +=item cdrtypenum - primary key + +=item typename - CDR type name + + +=back + +=head1 METHODS + +=over 4 + +=item new HASHREF + +Creates a new CDR type. To add the CDR type 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<hash> method. + +=cut + +# the new method can be inherited from FS::Record, if a table method is defined + +sub table { 'cdr_type'; } + +=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 CDR type. If there is +an error, returns the error, otherwise returns false. Called by the insert +and replace methods. + +=cut + +# the check method should currently be supplied - FS::Record contains some +# data checking routines + +sub check { + my $self = shift; + + my $error = + $self->ut_numbern('cdrtypenum') + || $self->ut_text('typename') + ; + return $error if $error; + + $self->SUPER::check; +} + +=back + +=head1 BUGS + +=head1 SEE ALSO + +L<FS::Record>, schema.html from the base documentation. + +=cut + +1; + |