1 package FS::cgp_rule_condition;
4 use base qw( FS::Record );
5 use FS::Record qw( qsearch qsearchs );
10 FS::cgp_rule_condition - Object methods for cgp_rule_condition records
14 use FS::cgp_rule_condition;
16 $record = new FS::cgp_rule_condition \%hash;
17 $record = new FS::cgp_rule_condition { 'column' => 'value' };
19 $error = $record->insert;
21 $error = $new_record->replace($old_record);
23 $error = $record->delete;
25 $error = $record->check;
29 An FS::cgp_rule_condition object represents a mail filtering condition.
30 FS::cgp_rule_condition inherits from FS::Record. The following fields are
35 =item ruleconditionnum
63 Creates a new condition. To add the condition to the database, see L<"insert">.
65 Note that this stores the hash reference, not a distinct copy of the hash it
66 points to. You can ask the object for a copy with the I<hash> method.
70 # the new method can be inherited from FS::Record, if a table method is defined
72 sub table { 'cgp_rule_condition'; }
76 Adds this record to the database. If there is an error, returns the error,
77 otherwise returns false.
81 # the insert method can be inherited from FS::Record
85 Delete this record from the database.
89 # the delete method can be inherited from FS::Record
91 =item replace OLD_RECORD
93 Replaces the OLD_RECORD with this one in the database. If there is an error,
94 returns the error, otherwise returns false.
98 # the replace method can be inherited from FS::Record
102 Checks all fields to make sure this is a valid condition. If there is
103 an error, returns the error, otherwise returns false. Called by the insert
108 # the check method should currently be supplied - FS::Record contains some
109 # data checking routines
115 $self->ut_numbern('ruleconditionnum')
116 || $self->ut_text('conditionname')
117 || $self->ut_textn('op')
118 || $self->ut_textn('params')
119 || $self->ut_foreign_key('rulenum', 'cgp_rule', 'rulenum')
121 return $error if $error;
128 Returns an array reference of the conditionname, op and params fields.
134 [ map $self->$_, qw( conditionname op params ) ];
143 L<FS::Record>, schema.html from the base documentation.