summaryrefslogtreecommitdiff
path: root/FS/FS/cust_contact.pm
blob: adad46e9e18eb9507061fbe4aea1ae394c91bfff (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
package FS::cust_contact;
use base qw( FS::Record );

use strict;
use FS::Record qw( qsearch qsearchs );

=head1 NAME

FS::cust_contact - Object methods for cust_contact records

=head1 SYNOPSIS

  use FS::cust_contact;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::cust_contact object represents a contact's attachment to a specific
customer.  FS::cust_contact inherits from FS::Record.  The following fields are
currently supported:

=over 4

=item custcontactnum

primary key

=item custnum

custnum

=item contactnum

contactnum

=item classnum

classnum

=item comment

comment

=item selfservice_access

empty or Y

=item invoice_dest

'Y' if the customer should get invoices sent to this address, null if not

=item message_dest

'Y' if contact should get non-invoice email messages sent to this address,
NULL if not

=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new record.  To add the record to the database, see L<"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 I<hash> method.

=cut

# the new method can be inherited from FS::Record, if a table method is defined

sub table { 'cust_contact'; }

=item insert

Adds this record to the database.  If there is an error, returns the error,
otherwise returns false.

=item delete

Delete this record from the database.

=item replace OLD_RECORD

Replaces the OLD_RECORD with this one in the database.  If there is an error,
returns the error, otherwise returns false.

=item 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.

=cut

# the check method should currently be supplied - FS::Record contains some
# data checking routines

sub check {
  my $self = shift;

  if ( $self->selfservice_access eq 'R' || $self->selfservice_access eq 'E' || $self->selfservice_access eq 'P') {
    $self->selfservice_access('Y');
    $self->_resend('Y');
  }

  my $error = 
    $self->ut_numbern('custcontactnum')
    || $self->ut_number('custnum')
    || $self->ut_number('contactnum')
    || $self->ut_numbern('classnum')
    || $self->ut_textn('comment')
    || $self->ut_enum('selfservice_access', [ '', 'Y' ])
    || $self->ut_flag('invoice_dest')
    || $self->ut_flag('message_dest')
  ;
  return $error if $error;

  $self->SUPER::check;
}

=item contact_classname

Returns the name of this contact's class (see L<FS::contact_class>).

=cut

sub contact_classname {
  my $self = shift;
  my $contact_class = $self->contact_class or return '';
  $contact_class->classname;
}

=back

=head1 BUGS

=head1 SEE ALSO

L<FS::contact>, L<FS::cust_main>, L<FS::Record>

=cut

1;