summaryrefslogtreecommitdiff
path: root/FS/FS/svc_realestate.pm
blob: 7c1fba87385ded27f8b6028bb577770193e70851 (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
package FS::svc_realestate;
use base qw(FS::svc_Common);

use strict;
use warnings;
use vars qw($conf);

use FS::Record qw(qsearchs qsearch dbh);
use Tie::IxHash;

$FS::UID::callback{'FS::svc_realestate'} = sub {
  $conf = new FS::Conf;
};

=head1 NAME

FS::svc_realestate - Object methods for svc_realestate records

=head1 SYNOPSIS

  {...} TODO

=head1 DESCRIPTION

A FS::svc_realestate object represents a billable real estate trasnaction,
such as renting a home or office.

FS::svc_realestate inherits from FS::svc_Common.  The following fields are
currently supported:

=over 4

=item svcnum - primary key

=back

=head1 METHODS

=over 4

=item new HASHREF

Instantiates a new svc_realestate object.

=cut

sub table_info {
  tie my %fields, 'Tie::IxHash',
    svcnum      => 'Service',
    description => 'Descriptive label',
    property    => 'Real estate property';

  {
    name            => 'Real estate',
    name_plural     => 'Real estate services',
    longname_plural => 'Real estate services',
    display_weight  => 100,
    cancel_weight   => 100,
    fields          => \%fields,
  };
}

sub table {'svc_realestate'};

# todo- In what context is this called? Mimic stub behavior w/o the warning
sub label { $_[0]->svcnum }

=item search_sql

I have an unfounded suspicion this method serves no purpose in this context

=cut

sub search_sql {die "search_sql called on FS::svc_realestate"}

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

=back 4

=head1 BUGS

=head1 SEE ALSO

L<FS::Record>, schema.html from the base documentation.

=cut

1;