1 package FS::radius_group;
4 use base qw( FS::Record );
5 use FS::Record qw( qsearch qsearchs );
9 FS::radius_group - Object methods for radius_group records
15 $record = new FS::radius_group \%hash;
16 $record = new FS::radius_group { 'column' => 'value' };
18 $error = $record->insert;
20 $error = $new_record->replace($old_record);
22 $error = $record->delete;
24 $error = $record->check;
28 An FS::radius_group object represents a RADIUS group. FS::radius_group inherits from
29 FS::Record. The following fields are currently supported:
54 Creates a new RADIUS group. To add the RADIUS group to the database, see L<"insert">.
56 Note that this stores the hash reference, not a distinct copy of the hash it
57 points to. You can ask the object for a copy with the I<hash> method.
61 # the new method can be inherited from FS::Record, if a table method is defined
63 sub table { 'radius_group'; }
67 Adds this record to the database. If there is an error, returns the error,
68 otherwise returns false.
72 # the insert method can be inherited from FS::Record
76 Delete this record from the database.
80 # the delete method can be inherited from FS::Record
82 =item replace OLD_RECORD
84 Replaces the OLD_RECORD with this one in the database. If there is an error,
85 returns the error, otherwise returns false.
89 # the replace method can be inherited from FS::Record
93 Checks all fields to make sure this is a valid RADIUS group. If there is
94 an error, returns the error, otherwise returns false. Called by the insert
99 # the check method should currently be supplied - FS::Record contains some
100 # data checking routines
106 $self->ut_numbern('groupnum')
107 || $self->ut_text('groupname')
108 || $self->ut_textn('description')
110 return $error if $error;
115 =item long_description
117 Returns a description for this group consisting of its description field,
118 if any, and the RADIUS group name.
122 sub long_description {
124 $self->description ? $self->description . " (". $self->groupname . ")"
132 This isn't export-specific (i.e. groups are globally unique, as opposed to being
137 L<FS::radius_usergroup>, L<FS::Record>, schema.html from the base documentation.