1 package FS::payment_gateway_option;
2 use base qw(FS::Record);
8 FS::payment_gateway_option - Object methods for payment_gateway_option records
12 use FS::payment_gateway_option;
14 $record = new FS::payment_gateway_option \%hash;
15 $record = new FS::payment_gateway_option { 'column' => 'value' };
17 $error = $record->insert;
19 $error = $new_record->replace($old_record);
21 $error = $record->delete;
23 $error = $record->check;
27 An FS::payment_gateway_option object represents an option key and value for
28 a payment gateway. FS::payment_gateway_option inherits from
29 FS::Record. The following fields are currently supported:
33 =item optionnum - primary key
50 Creates a new option. To add the option to the database, see L<"insert">.
52 Note that this stores the hash reference, not a distinct copy of the hash it
53 points to. You can ask the object for a copy with the I<hash> method.
57 # the new method can be inherited from FS::Record, if a table method is defined
59 sub table { 'payment_gateway_option'; }
63 Adds this record to the database. If there is an error, returns the error,
64 otherwise returns false.
68 # the insert method can be inherited from FS::Record
72 Delete this record from the database.
76 # the delete method can be inherited from FS::Record
78 =item replace OLD_RECORD
80 Replaces the OLD_RECORD with this one in the database. If there is an error,
81 returns the error, otherwise returns false.
85 # the replace method can be inherited from FS::Record
89 Checks all fields to make sure this is a valid option. If there is
90 an error, returns the error, otherwise returns false. Called by the insert
95 # the check method should currently be supplied - FS::Record contains some
96 # data checking routines
102 $self->ut_numbern('optionnum')
103 || $self->ut_foreign_key('gatewaynum', 'payment_gateway', 'gatewaynum')
104 || $self->ut_text('optionname')
105 || $self->ut_textn('optionvalue')
107 return $error if $error;
118 L<FS::Record>, schema.html from the base documentation.