Freeside:4:Documentation:Developer/FS/usage class

From Freeside
Jump to: navigation, search

NAME

FS::usage_class - Object methods for usage_class records

SYNOPSIS

 use FS::usage_class;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::usage_class object represents a usage class. Every rate detail (see FS::rate_detail) has, optionally, a usage class. FS::usage_class inherits from FS::Record. The following fields are currently supported:

classnum
Primary key (assigned automatically for new usage classes)
classname
Text name of this usage class
disabled
Disabled flag, empty or 'Y'

METHODS

new HASHREF
Creates a new usage class. To add the usage class 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 usage class. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
summary_formats_labelhash
Returns a list of line item format descriptions suitable for assigning to a hash.
header_generator FORMAT
Returns a coderef used for generation of an invoice line item header for this usage_class. FORMAT is either html or latex
description_generator FORMAT
Returns a coderef used for generation of invoice line items for this usage_class. FORMAT is either html or latex
total_generator FORMAT
Returns a coderef used for generation of invoice total lines for this usage_class. FORMAT is either html or latex
total_line_generator FORMAT
Returns a coderef used for generation of invoice total line items for this usage_class. FORMAT is either html or latex

BUGS

SEE ALSO

FS::Record, schema.html from the base documentation.