diff options
Diffstat (limited to 'FS/FS/cancel_reason.pm')
-rw-r--r-- | FS/FS/cancel_reason.pm | 123 |
1 files changed, 123 insertions, 0 deletions
diff --git a/FS/FS/cancel_reason.pm b/FS/FS/cancel_reason.pm new file mode 100644 index 000000000..19cc7214e --- /dev/null +++ b/FS/FS/cancel_reason.pm @@ -0,0 +1,123 @@ +package FS::cancel_reason; + +use strict; +use vars qw( @ISA ); +use FS::Record qw( qsearch qsearchs ); + +@ISA = qw(FS::Record); + +=head1 NAME + +FS::cancel_reason - Object methods for cancel_reason records + +=head1 SYNOPSIS + + use FS::cancel_reason; + + $record = new FS::cancel_reason \%hash; + $record = new FS::cancel_reason { 'column' => 'value' }; + + $error = $record->insert; + + $error = $new_record->replace($old_record); + + $error = $record->delete; + + $error = $record->check; + +=head1 DESCRIPTION + +An FS::cancel_reason object represents an cancellation reason. +FS::cancel_reason inherits from FS::Record. The following fields are +currently supported: + +=over 4 + +=item reasonnum - primary key + +=item reason - + +=item disabled - empty or "Y" + +=back + +=head1 METHODS + +=over 4 + +=item new HASHREF + +Creates a new cancellation reason. To add the reason 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 { 'cancel_reason'; } + +=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 reason. 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('reasonnum') + || $self->ut_text('reason') + || $self->ut_enum('disabled', [ '', 'Y' ] ) + ; + return $error if $error; + + $self->SUPER::check; +} + +=back + +=head1 BUGS + +=head1 SEE ALSO + +L<FS::Record>, schema.html from the base documentation. + +=cut + +1; + |