diff options
author | ivan <ivan> | 2011-02-27 00:52:29 +0000 |
---|---|---|
committer | ivan <ivan> | 2011-02-27 00:52:29 +0000 |
commit | f4f7bb4086cdaf2699c6d028b76e99b3e9be1e90 (patch) | |
tree | ea1d3ad4c176a286f71758b524aee18b4aa722c1 /FS/FS/torrus_srvderive_component.pm | |
parent | 8cec20dd7f69a3fb7b6a5e6a853747833e8a7784 (diff) |
torrus virtual ports, RT#10574
Diffstat (limited to 'FS/FS/torrus_srvderive_component.pm')
-rw-r--r-- | FS/FS/torrus_srvderive_component.pm | 127 |
1 files changed, 127 insertions, 0 deletions
diff --git a/FS/FS/torrus_srvderive_component.pm b/FS/FS/torrus_srvderive_component.pm new file mode 100644 index 0000000..046b674 --- /dev/null +++ b/FS/FS/torrus_srvderive_component.pm @@ -0,0 +1,127 @@ +package FS::torrus_srvderive_component; + +use strict; +use base qw( FS::Record ); +use FS::Record qw( qsearch qsearchs ); + +=head1 NAME + +FS::torrus_srvderive_component - Object methods for torrus_srvderive_component records + +=head1 SYNOPSIS + + use FS::torrus_srvderive_component; + + $record = new FS::torrus_srvderive_component \%hash; + $record = new FS::torrus_srvderive_component { 'column' => 'value' }; + + $error = $record->insert; + + $error = $new_record->replace($old_record); + + $error = $record->delete; + + $error = $record->check; + +=head1 DESCRIPTION + +An FS::torrus_srvderive_component object represents a component of a Torrus +virtual service ID. FS::torrus_srvderive_component inherits from FS::Record. +The following fields are currently supported: + +=over 4 + +=item componentnum + +primary key + +=item derivenum + +derivenum + +=item serviceid + +serviceid + + +=back + +=head1 METHODS + +=over 4 + +=item new HASHREF + +Creates a new record. To add the record 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 { 'torrus_srvderive_component'; } + +=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 record. 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('componentnum') + || $self->ut_number('derivenum') + || $self->ut_text('serviceid') + ; + return $error if $error; + + $self->SUPER::check; +} + +=back + +=head1 BUGS + +=head1 SEE ALSO + +L<FS::Record>, schema.html from the base documentation. + +=cut + +1; + |