fix quotations, RT#21103
[freeside.git] / FS / FS / access_groupsales.pm
1 package FS::access_groupsales;
2
3 use strict;
4 use base qw( FS::Record );
5 use FS::Record qw( qsearch qsearchs );
6
7 =head1 NAME
8
9 FS::access_groupsales - Object methods for access_groupsales records
10
11 =head1 SYNOPSIS
12
13   use FS::access_groupsales;
14
15   $record = new FS::access_groupsales \%hash;
16   $record = new FS::access_groupsales { 'column' => 'value' };
17
18   $error = $record->insert;
19
20   $error = $new_record->replace($old_record);
21
22   $error = $record->delete;
23
24   $error = $record->check;
25
26 =head1 DESCRIPTION
27
28 An FS::access_groupsales object represents an example.  FS::access_groupsales inherits from
29 FS::Record.  The following fields are currently supported:
30
31 =over 4
32
33 =item groupsalesnum
34
35 primary key
36
37 =item groupnum
38
39 groupnum
40
41 =item salesnum
42
43 salesnum
44
45
46 =back
47
48 =head1 METHODS
49
50 =over 4
51
52 =item new HASHREF
53
54 Creates a new example.  To add the example to the database, see L<"insert">.
55
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.
58
59 =cut
60
61 # the new method can be inherited from FS::Record, if a table method is defined
62
63 sub table { 'access_groupsales'; }
64
65 =item insert
66
67 Adds this record to the database.  If there is an error, returns the error,
68 otherwise returns false.
69
70 =cut
71
72 # the insert method can be inherited from FS::Record
73
74 =item delete
75
76 Delete this record from the database.
77
78 =cut
79
80 # the delete method can be inherited from FS::Record
81
82 =item replace OLD_RECORD
83
84 Replaces the OLD_RECORD with this one in the database.  If there is an error,
85 returns the error, otherwise returns false.
86
87 =cut
88
89 # the replace method can be inherited from FS::Record
90
91 =item check
92
93 Checks all fields to make sure this is a valid example.  If there is
94 an error, returns the error, otherwise returns false.  Called by the insert
95 and replace methods.
96
97 =cut
98
99 # the check method should currently be supplied - FS::Record contains some
100 # data checking routines
101
102 sub check {
103   my $self = shift;
104
105   my $error = 
106     $self->ut_numbern('groupsalesnum')
107     || $self->ut_number('groupnum')
108     || $self->ut_number('salesnum')
109   ;
110   return $error if $error;
111
112   $self->SUPER::check;
113 }
114
115 =back
116
117 =item sales
118
119 Returns the associated FS::agent object.
120
121 =cut
122
123 sub sales {
124   my $self = shift;
125   qsearchs('sales', { 'salesnum' => $self->salesnum } );
126 }
127
128 =item access_group
129
130 Returns the associated FS::access_group object.
131
132 =cut
133
134 sub access_group {
135   my $self = shift;
136   qsearchs('access_group', { 'groupnum' => $self->groupnum } );
137 }
138
139 =back
140
141
142 =head1 BUGS
143
144 The author forgot to customize this manpage.
145
146 =head1 SEE ALSO
147
148 L<FS::Record>, schema.html from the base documentation.
149
150 =cut
151
152 1;
153