Difference between revisions of "Freeside:4:Documentation:Developer/FS/export svc"

Latest revision as of 07:22, 18 November 2015

NAME

FS::export_svc - Object methods for export_svc records

SYNOPSIS

 use FS::export_svc;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::export_svc object links a service definition (see FS::part_svc) to an export (see FS::part_export). FS::export_svc inherits from FS::Record. The following fields are currently supported:

exportsvcnum - primary key; exportnum - export (see FS::part_export); svcpart - service definition (see FS::part_svc); role - export role (see export parameters)

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 [ JOB, OFFSET, MULTIPLIER ]

Adds this record to the database. If there is an error, returns the error, otherwise returns false.

TODOC: JOB, OFFSET, MULTIPLIER

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_svc

Returns the FS::part_svc object (see FS::part_svc).

svc_export_machine

Returns all export hostname records (FS::svc_export_machine) for this combination of svcpart and exportnum.

BUGS

SEE ALSO

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