Freeside:4:Documentation:Developer/FS/vend main
From Freeside
< Freeside:4:Documentation:Developer | FS
Revision as of 07:31, 18 November 2015 by Jeremyd (talk | contribs) (Edit via perl MediaWiki framework (1.13))
Contents
NAME
FS::vend_main - Object methods for vend_main records
SYNOPSIS
use FS::vend_main; $record = new FS::vend_main \%hash; $record = new FS::vend_main { 'column' => 'value' }; $error = $record->insert; $error = $new_record->replace($old_record); $error = $record->delete; $error = $record->check;
DESCRIPTION
An FS::vend_main object represents a vendor. FS::vend_main inherits from FS::Record. The following fields are currently supported:
- vendnum
- primary key
- vendname
- vendname
- classnum
- classnum
- disabled
- disabled
METHODS
- new HASHREF
- Creates a new vendor. To add the vendor 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. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
- vend_class; search
BUGS
SEE ALSO
FS::Record, schema.html from the base documentation.