summaryrefslogtreecommitdiff
path: root/FS/FS/part_svc_column.pm
blob: e055af35ab88586049292ef7bdc2250efd86d49c (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
package FS::part_svc_column;

use strict;
use vars qw( @ISA );
use FS::Record qw( fields );

@ISA = qw(FS::Record);

=head1 NAME

FS::part_svc_column - Object methods for part_svc_column objects

=head1 SYNOPSIS

  use FS::part_svc_column;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::part_svc_column record represents a service definition column
constraint.  FS::part_svc_column inherits from FS::Record.  The following
fields are currently supported:

=over 4

=item columnnum - primary key (assigned automatcially for new records)

=item svcpart - service definition (see L<FS::part_svc>)

=item columnname - column name in part_svc.svcdb table

=item columnlabel - label for the column

=item columnvalue - default or fixed value for the column

=item columnflag - null or empty (no default), `D' for default, `F' for fixed (unchangeable), `S' for selectable choice, `M' for manual selection from inventory, `A' for automatic selection from inventory, or `H' for selection from a hardware class.  For virtual fields, can also be 'X' for excluded.

=item required - column value expected to be true

=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new column constraint.  To add the column constraint to the database, see L<"insert">.

=cut

sub table { 'part_svc_column'; }

=item insert

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

=item delete

Deletes this record from the database.  If there is an error, returns the
error, otherwise returns false.

=item replace OLD_RECORD

Replaces 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

sub check {
  my $self = shift;

  my $error =
    $self->ut_numbern('columnnum')
    || $self->ut_number('svcpart')
    || $self->ut_alpha('columnname')
    || $self->ut_textn('columnlabel')
    || $self->ut_anything('columnvalue')
    || $self->ut_flag('required')
  ;
  return $error if $error;

  $self->columnflag =~ /^([DFSMAHXP]?)$/
    or return "illegal columnflag ". $self->columnflag;
  $self->columnflag(uc($1));

  if ( $self->columnflag =~ /^[MA]$/ ) {
    # split, check all values independently, and normalize
    my @classnums = split(/\s*,\s*/, $self->columnvalue);
    foreach (@classnums) {
      $self->set('columnvalue', $_);
      $error = $self->ut_foreign_key( 'columnvalue', 'inventory_class', 'classnum' );
      return $error if $error;
    }
    $self->set('columnvalue', join(',', @classnums));
  }
  if ( $self->columnflag eq 'H' ) {
    $error = 
      $self->ut_foreign_key( 'columnvalue', 'hardware_class', 'classnum' );
  }
  return $error if $error;

  $self->SUPER::check;
}

=back

=head1 BUGS

=head1 SEE ALSO

L<FS::Record>, L<FS::part_svc>, L<FS::part_pkg>, L<FS::pkg_svc>,
L<FS::cust_svc>, L<FS::svc_acct>, L<FS::svc_forward>, L<FS::svc_domain>,
schema.html from the base documentation.

=cut

1;