time/data/etc. unit pricing add-ons, RT#24392

[freeside.git] / FS / FS / part_pkg_usageprice.pm

diff --git a/FS/FS/part_pkg_usageprice.pm b/FS/FS/part_pkg_usageprice.pm
new file mode 100644 (file)
index 0000000..0fa6bca
--- /dev/null
+++ b/FS/FS/part_pkg_usageprice.pm
@@ -0,0 +1,134 @@
+package FS::part_pkg_usageprice;
+use base qw( FS::Record );
+
+use strict;
+#use FS::Record qw( qsearch qsearchs );
+
+=head1 NAME
+
+FS::part_pkg_usageprice - Object methods for part_pkg_usageprice records
+
+=head1 SYNOPSIS
+
+  use FS::part_pkg_usageprice;
+
+  $record = new FS::part_pkg_usageprice \%hash;
+  $record = new FS::part_pkg_usageprice { 'column' => 'value' };
+
+  $error = $record->insert;
+
+  $error = $new_record->replace($old_record);
+
+  $error = $record->delete;
+
+  $error = $record->check;
+
+=head1 DESCRIPTION
+
+An FS::part_pkg_usageprice object represents a usage pricing add-on.
+FS::part_pkg_usageprice inherits from FS::Record.  The following fields are
+currently supported:
+
+=over 4
+
+=item usagepricepart
+
+primary key
+
+=item pkgpart
+
+pkgpart
+
+=item price
+
+price
+
+=item currency
+
+currency
+
+=item action
+
+action
+
+=item target
+
+target
+
+=item amount
+
+amount
+
+
+=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
+
+sub table { 'part_pkg_usageprice'; }
+
+=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
+
+sub check {
+  my $self = shift;
+
+  my $error = 
+    $self->ut_numbern('usagepricepart')
+    || $self->ut_number('pkgpart')
+    || $self->ut_money('price')
+    || $self->ut_currencyn('currency')
+    || $self->ut_enum('action', [ 'increment', 'set' ])
+    || $self->ut_enum('target', [ 'svc_acct.totalbytes', 'svc_acct.seconds',
+                                  'svc_conferencing.participants',
+                                  'svc_conferencing.confqualitynum'
+                                ]
+                     )
+    || $self->ut_text('amount')
+  ;
+  return $error if $error;
+
+  $self->SUPER::check;
+}
+
+=back
+
+=head1 BUGS
+
+=head1 SEE ALSO
+
+L<FS::part_pkg>, L<FS::Record>
+
+=cut
+
+1;
+