Freeside:3:Documentation:Developer/FS/part pkg vendor

From Freeside
Jump to: navigation, search

NAME

FS::part_pkg_vendor - Object methods for part_pkg_vendor records

SYNOPSIS

 use FS::part_pkg_vendor;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::part_pkg_vendor object represents a mapping of pkgpart numbers to external package numbers. FS::part_pkg_vendor inherits from FS::Record. The following fields are currently supported:

num
primary key
pkgpart
pkgpart
exportnum
exportnum
vendor_pkg_id
vendor_pkg_id

METHODS

new HASHREF
Creates a new example. To add the example 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 example. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
part_export
Returns the FS::part_export associated with this vendor/external package id.

SEE ALSO

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