summaryrefslogtreecommitdiff
path: root/FS/FS/sched_item.pm
blob: 5f55188e61fb1eff8c93c3c9b3d3a8de039cfbb2 (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
package FS::sched_item;
use base qw( FS::Record );

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

=head1 NAME

FS::sched_item - Object methods for sched_item records

=head1 SYNOPSIS

  use FS::sched_item;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::sched_item object represents an schedulable item, such as an installer,
meeting room or truck.  FS::sched_item inherits from FS::Record.  The following
fields are currently supported:

=over 4

=item itemnum

primary key

=item usernum

usernum

=item disabled

disabled


=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new item.  To add the item 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

sub table { 'sched_item'; }

=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 item.  If there is
an error, returns the error, otherwise returns false.  Called by the insert
and replace methods.

=cut

sub check {
  my $self = shift;

  my $error = 
    $self->ut_numbern('itemnum')
    || $self->ut_foreign_keyn('usernum', 'access_user', 'usernum')
    || $self->ut_enum('disabled', [ '', 'Y' ])
  ;
  return $error if $error;

  $self->SUPER::check;
}

=item name

Returns a name for this item; either the name of the associated employee (see
L<FS::access_user), or the itemname field.

=cut

sub name {
  my $self = shift;
  my $access_user = $self->access_user;
  $access_user ? $access_user->name : $self->itemname;
}

=back

=head1 BUGS

=head1 SEE ALSO

L<FS::access_user>, L<FS::sched_avail>, L<FS::Record>

=cut

1;