Difference between revisions of "Freeside:3:Documentation:Developer/FS/part event option"

Latest revision as of 20:05, 27 June 2012

NAME

FS::part_event_option - Object methods for part_event_option records

SYNOPSIS

 use FS::part_event_option;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::part_event_option object represents an event definition option (action option). FS::part_event_option inherits from FS::Record. The following fields are currently supported:

optionnum - primary key; eventpart - Event definition (see FS::part_event); optionname - Option name; optionvalue - Option value

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.

SEE ALSO

FS::part_event, FS::Record, schema.html from the base documentation.