separate ACL for editing customer invoice terms, RT#75759
[freeside.git] / FS / FS / access_usergroup.pm
1 package FS::access_usergroup;
2 use base qw(FS::Record);
3
4 use strict;
5
6 =head1 NAME
7
8 FS::access_usergroup - Object methods for access_usergroup records
9
10 =head1 SYNOPSIS
11
12   use FS::access_usergroup;
13
14   $record = new FS::access_usergroup \%hash;
15   $record = new FS::access_usergroup { 'column' => 'value' };
16
17   $error = $record->insert;
18
19   $error = $new_record->replace($old_record);
20
21   $error = $record->delete;
22
23   $error = $record->check;
24
25 =head1 DESCRIPTION
26
27 An FS::access_usergroup object represents an internal access user's membership
28 in a group.  FS::access_usergroup inherits from FS::Record.  The following
29 fields are currently supported:
30
31 =over 4
32
33 =item usergroupnum - primary key
34
35 =item usernum - 
36
37 =item groupnum - 
38
39
40 =back
41
42 =head1 METHODS
43
44 =over 4
45
46 =item new HASHREF
47
48 Creates a new record.  To add the record to the database, see L<"insert">.
49
50 Note that this stores the hash reference, not a distinct copy of the hash it
51 points to.  You can ask the object for a copy with the I<hash> method.
52
53 =cut
54
55 # the new method can be inherited from FS::Record, if a table method is defined
56
57 sub table { 'access_usergroup'; }
58
59 =item insert
60
61 Adds this record to the database.  If there is an error, returns the error,
62 otherwise returns false.
63
64 =cut
65
66 # the insert method can be inherited from FS::Record
67
68 =item delete
69
70 Delete this record from the database.
71
72 =cut
73
74 # the delete method can be inherited from FS::Record
75
76 =item replace OLD_RECORD
77
78 Replaces the OLD_RECORD with this one in the database.  If there is an error,
79 returns the error, otherwise returns false.
80
81 =cut
82
83 # the replace method can be inherited from FS::Record
84
85 =item check
86
87 Checks all fields to make sure this is a valid record.  If there is
88 an error, returns the error, otherwise returns false.  Called by the insert
89 and replace methods.
90
91 =cut
92
93 # the check method should currently be supplied - FS::Record contains some
94 # data checking routines
95
96 sub check {
97   my $self = shift;
98
99   my $error = 
100     $self->ut_numbern('usergroupnum')
101     || $self->ut_number('usernum')
102     || $self->ut_number('groupnum')
103   ;
104   return $error if $error;
105
106   $self->SUPER::check;
107 }
108
109 =item access_user
110
111 =item access_group
112
113 =back
114
115 =head1 BUGS
116
117 =head1 SEE ALSO
118
119 L<FS::Record>, schema.html from the base documentation.
120
121 =cut
122
123 1;
124