Freeside:3:Documentation:Developer/FS/export device
From Freeside
Contents
NAME
FS::export_device - Object methods for export_device records
SYNOPSIS
use FS::export_device; $record = new FS::export_device \%hash; $record = new FS::export_device { 'column' => 'value' }; $error = $record->insert; $error = $new_record->replace($old_record); $error = $record->delete; $error = $record->check;
DESCRIPTION
An FS::export_device object links a device definition (see FS::part_device) to an export (see FS::part_export). FS::export_device inherits from FS::Record. The following fields are currently supported:
- exportdevicenum - primary key; exportnum - export (see FS::part_export); devicepart - device definition (see FS::part_device)
METHODS
- new HASHREF
- Creates a new record. To add the record 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 record. 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 object (see FS::part_export).
- part_device
- Returns the FS::part_device object (see FS::part_device).
BUGS
SEE ALSO
FS::part_export, FS::part_device, FS::Record, schema.html from the base documentation.