% include( '/elements/header.html', 'Developer Documentation' ) %> <& /elements/menubar.html, 'Freeside Perl Modules' => $fsurl.'docs/library/FS.html', 'Complete Index' => $fsurl.'docs/library/index.html', &>
FS::part_svc - Object methods for part_svc objects
use FS::part_svc;
$record = new FS::part_svc \%hash
$record = new FS::part_svc { 'column' => 'value' };
$error = $record->insert;
$error = $record->insert( [ 'pseudofield' ] );
$error = $record->insert( [ 'pseudofield' ], \%exportnums );
$error = $new_record->replace($old_record);
$error = $new_record->replace($old_record, '1.3-COMPAT', [ 'pseudofield' ] );
$error = $new_record->replace($old_record, '1.3-COMPAT', [ 'pseudofield' ], \%exportnums );
$error = $record->delete;
$error = $record->check;
An FS::part_svc represents a service definition. FS::part_svc inherits from FS::Record. The following fields are currently supported:
Creates a new service definition. To add the service definition to the database, see "insert".
Adds this service definition to the database. If there is an error, returns the error, otherwise returns false.
The following pseudo-fields may be defined, and will be maintained in the part_svc_column table appropriately (see FS::part_svc_column).
If you want to add part_svc_column records for fields that do not exist as fields in the svcdb table, make sure to list then in EXTRA_FIELDS_ARRAYREF also.
If EXPORTNUMS_HASHREF is specified (keys are exportnums and values are boolean), the appopriate export_svc records will be inserted.
TODOC: JOB
Currently unimplemented. Set the "disabled" field instead.
Replaces OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
TODOC: 1.3-COMPAT
TODOC: EXTRA_FIELDS_ARRAYREF (same as insert method)
TODOC: JOB
Checks all fields to make sure this is a valid service definition. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
Returns the part_svc_column object (see FS::part_svc_column) for the given COLUMNNAME, or a new part_svc_column object if none exists.
Returns a list of all exports (see FS::part_export) for this service, or, if an export type is specified, only returns exports of the given type.
Returns a list of any exports (see FS::part_export) for this service that are capable of reporting usage information.
Returns a list of any exports (see FS::part_export) for this service that are capable of returing available DID (phone number) information.
Returns a list of any exports (see FS::part_export) for this service that are capable of pulling/pushing DSL orders.
Returns a list of any exports (see FS::part_export) for this service that are capable of pushing a change after part svc is changed.
Returns a list of associated customer services (FS::cust_svc records).
If a PKGPART is specified, returns the customer services which are contained within packages of that type (see FS::part_pkg). If PKGPARTis specified as 0, returns unlinked customer services.
Returns the number of associated customer services (FS::cust_svc records).
If a PKGPART is specified, returns the number of customer services which are contained within packages of that type (see FS::part_pkg). If PKGPART is specified as 0, returns the number of unlinked customer services.
Returns the number of associated customer services that are attached to cancelled packages.
Returns a list of associated FS::svc_* records.
Returns a customer-viewable service definition label in the chosen LOCALE. If there is no entry for that locale or if LOCALE is empty, returns part_svc.svc.
Returns a list of all svc_ tables.
Given a table name, returns a hashref of field names. The field names returned are those with additional (service-definition related) information, not necessarily all database fields of the table. Pseudo-fields may also be returned (i.e. svc_acct.usergroup).
Each value of the hashref is another hashref, which can have one or more of the following keys:
Returns table_info for TABLE from cache, or empty hashref if none is found.
Caution: caches table_info for ALL services when run; access a service's table_info directly unless you know you're loading them all.
Caution: does not standardize fields into hashrefs; use "svc_table_fields" to access fields.
Job-queue processor for web interface adds/edits
Job-queue processor for web interface bulk customer service changes
Delete is unimplemented.
The list of svc_* tables is no longer hardcoded, but svc_acct_pop is skipped as a special case until it is renamed.
all_part_svc_column methods should be documented
FS::Record, FS::part_svc_column, FS::part_pkg, FS::pkg_svc, FS::cust_svc, FS::svc_acct, FS::svc_forward, FS::svc_domain, schema.html from the base documentation.
Hey! The above document had some coding errors, which are explained below:
You forgot a '=back' before '=head1'