Difference between revisions of "Freeside:1.9:Documentation:Developer/FS/pkg svc"
From Freeside
(import from POD) |
(import from POD) |
||
Line 27: | Line 27: | ||
==METHODS== | ==METHODS== | ||
; new HASHREF | ; new HASHREF | ||
− | :Create a new record. To add the record to the database, see [[ | + | :Create a new record. To add the record to the database, see [[#insert|"insert"]]. |
; insert | ; insert | ||
:Adds this record to the database. If there is an error, returns the error, otherwise returns false. | :Adds this record to the database. If there is an error, returns the error, otherwise returns false. |
Latest revision as of 17:26, 3 October 2007
Contents
NAME
FS::pkg_svc - Object methods for pkg_svc records
SYNOPSIS
use FS::pkg_svc; $record = new FS::pkg_svc \%hash; $record = new FS::pkg_svc { 'column' => 'value' }; $error = $record->insert; $error = $new_record->replace($old_record); $error = $record->delete; $error = $record->check; $part_pkg = $record->part_pkg; $part_svc = $record->part_svc;
DESCRIPTION
An FS::pkg_svc record links a billing item definition (see FS::part_pkg) to a service definition (see FS::part_svc). FS::pkg_svc inherits from FS::Record. The following fields are currently supported:
- pkgsvcnum - primary key; pkgpart - Billing item definition (see FS::part_pkg); svcpart - Service definition (see FS::part_svc); quantity - Quantity of this service definition that this billing item definition includes; primary_svc - primary flag, empty or 'Y'
METHODS
- new HASHREF
- Create a new record. To add the record to the database, see "insert".
- insert
- Adds this record to the database. If there is an error, returns the error, otherwise returns false.
- delete
- Deletes this record from the database. If there is an error, returns the error, otherwise returns false.
- replace OLD_RECORD
- Replaces 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 record. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
- part_pkg
- Returns the FS::part_pkg object (see FS::part_pkg).
- part_svc
- Returns the FS::part_svc object (see FS::part_svc).
BUGS
SEE ALSO
FS::Record, FS::part_pkg, FS::part_svc, schema.html from the base documentation.