FS/FS/part_svc_msgcat.pm

   1 package FS::part_svc_msgcat;
   2 use base qw( FS::Record );
   3
   4 use strict;
   5 use FS::Locales;
   6
   7 =head1 NAME
   8
   9 FS::part_svc_msgcat - Object methods for part_svc_msgcat records
  10
  11 =head1 SYNOPSIS
  12
  13   use FS::part_svc_msgcat;
  14
  15   $record = new FS::part_svc_msgcat \%hash;
  16   $record = new FS::part_svc_msgcat { '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::part_svc_msgcat object represents localized labels of a service
  29 definition.  FS::part_svc_msgcat inherits from FS::Record.  The following
  30 fields are currently supported:
  31
  32 =over 4
  33
  34 =item svcpartmsgnum
  35
  36 primary key
  37
  38 =item svcpart
  39
  40 Service definition
  41
  42 =item locale
  43
  44 locale
  45
  46 =item svc
  47
  48 Localized service name (customer-viewable)
  49
  50 =back
  51
  52 =head1 METHODS
  53
  54 =over 4
  55
  56 =item new HASHREF
  57
  58 Creates a new record.  To add the record to the database, see L<"insert">.
  59
  60 Note that this stores the hash reference, not a distinct copy of the hash it
  61 points to.  You can ask the object for a copy with the I<hash> method.
  62
  63 =cut
  64
  65 # the new method can be inherited from FS::Record, if a table method is defined
  66
  67 sub table { 'part_svc_msgcat'; }
  68
  69 =item insert
  70
  71 Adds this record to the database.  If there is an error, returns the error,
  72 otherwise returns false.
  73
  74 =cut
  75
  76 # the insert method can be inherited from FS::Record
  77
  78 =item delete
  79
  80 Delete this record from the database.
  81
  82 =cut
  83
  84 # the delete method can be inherited from FS::Record
  85
  86 =item replace OLD_RECORD
  87
  88 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  89 returns the error, otherwise returns false.
  90
  91 =cut
  92
  93 # the replace method can be inherited from FS::Record
  94
  95 =item check
  96
  97 Checks all fields to make sure this is a valid record.  If there is
  98 an error, returns the error, otherwise returns false.  Called by the insert
  99 and replace methods.
 100
 101 =cut
 102
 103 # the check method should currently be supplied - FS::Record contains some
 104 # data checking routines
 105
 106 sub check {
 107   my $self = shift;
 108
 109   my $error =
 110     $self->ut_numbern('svcpartmsgnum')
 111     || $self->ut_foreign_key('svcpart', 'part_svc', 'svcpart')
 112     || $self->ut_enum('locale', [ FS::Locales->locales ] )
 113     || $self->ut_text('svc')
 114   ;
 115   return $error if $error;
 116
 117   $self->SUPER::check;
 118 }
 119
 120 =back
 121
 122 =head1 BUGS
 123
 124 =head1 SEE ALSO
 125
 126 L<FS::part_svc>, L<FS::Record>, schema.html from the base documentation.
 127
 128 =cut
 129
 130 1;
 131