View source for Freeside:3:Documentation:Developer/FS/reg code pkg

==NAME==
FS::reg_code_pkg - Class linking registration codes (see [[Freeside:3:Documentation:Developer/FS/reg code|FS::reg_code]]) with package definitions (see [[Freeside:3:Documentation:Developer/FS/part pkg|FS::part_pkg]])

==SYNOPSIS==
<code>
  use FS::reg_code_pkg;
 
  $record = new FS::reg_code_pkg \%hash;
  $record = new FS::reg_code_pkg { 'column' => 'value' };
 
  $error = $record->insert;
 
  $error = $new_record->replace($old_record);
 
  $error = $record->delete;
 
  $error = $record->check;
</code>
==DESCRIPTION==
An FS::reg_code_pkg object links a registration code to a package definition. FS::table_name inherits from FS::Record. The following fields are currently supported:

; codepkgnum - primary key; codenum - registration code (see [[Freeside:3:Documentation:Developer/FS/reg code|FS::reg_code]]); pkgpart - package definition (see [[Freeside:3:Documentation:Developer/FS/part pkg|FS::part_pkg]])
==METHODS==
; new HASHREF
:Creates a new registration code. To add the registration code to the database, see [[#insert|"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_pkg
:Returns the package definition (see [[Freeside:3:Documentation:Developer/FS/part pkg|FS::part_pkg]])

==BUGS==
Feeping creaturitis.

==SEE ALSO==
[[Freeside:3:Documentation:Developer/FS/reg code pkg|FS::reg_code_pkg]], [[Freeside:3:Documentation:Developer/FS/Record|FS::Record]], schema.html from the base documentation.