Difference between revisions of "Freeside:3:Documentation:Developer/FS/vend class"

Latest revision as of 06:37, 24 March 2015

NAME

FS::vend_class - Object methods for vend_class records

SYNOPSIS

 use FS::vend_class;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::vend_class object represents a vendor class. FS::vend_class inherits from FS::Record. The following fields are currently supported:

classnum

primary key

classname

classname

disabled

disabled

METHODS

new HASHREF

Creates a new vendor class. To add the vendor 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 vendor class. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

BUGS

SEE ALSO

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