diff options
Diffstat (limited to 'FS/FS/inventory_item.pm')
-rw-r--r-- | FS/FS/inventory_item.pm | 182 |
1 files changed, 182 insertions, 0 deletions
diff --git a/FS/FS/inventory_item.pm b/FS/FS/inventory_item.pm new file mode 100644 index 0000000..39a0dff --- /dev/null +++ b/FS/FS/inventory_item.pm @@ -0,0 +1,182 @@ +package FS::inventory_item; + +use strict; +use vars qw( @ISA ); +use FS::Record qw( dbh qsearch qsearchs ); +use FS::cust_main_Mixin; +use FS::inventory_class; +use FS::cust_svc; + +@ISA = qw( FS::cust_main_Mixin FS::Record ); + +=head1 NAME + +FS::inventory_item - Object methods for inventory_item records + +=head1 SYNOPSIS + + use FS::inventory_item; + + $record = new FS::inventory_item \%hash; + $record = new FS::inventory_item { 'column' => 'value' }; + + $error = $record->insert; + + $error = $new_record->replace($old_record); + + $error = $record->delete; + + $error = $record->check; + +=head1 DESCRIPTION + +An FS::inventory_item object represents a specific piece of (real or virtual) +inventory, such as a specific DID or serial number. FS::inventory_item +inherits from FS::Record. The following fields are currently supported: + +=over 4 + +=item itemnum - primary key + +=item classnum - Inventory class (see L<FS::inventory_class>) + +=item item - Item identifier (unique within its inventory class) + +=item svcnum - Customer servcie (see L<FS::cust_svc>) + +=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 + +# the new method can be inherited from FS::Record, if a table method is defined + +sub table { 'inventory_item'; } + +=item insert + +Adds this record to the database. If there is an error, returns the error, +otherwise returns false. + +=cut + +# the insert method can be inherited from FS::Record + +=item delete + +Delete this record from the database. + +=cut + +# the delete method can be inherited from FS::Record + +=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. + +=cut + +# the replace method can be inherited from FS::Record + +=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 + +# the check method should currently be supplied - FS::Record contains some +# data checking routines + +sub check { + my $self = shift; + + my $error = + $self->ut_numbern('itemnum') + || $self->ut_foreign_key('classnum', 'inventory_class', 'classnum' ) + #|| $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum' ) + || $self->ut_agentnum_acl('agentnum', ['Configuration', + 'Edit global inventory'] ) + || $self->ut_text('item') + || $self->ut_foreign_keyn('svcnum', 'cust_svc', 'svcnum' ) + ; + return $error if $error; + + $self->SUPER::check; +} + +=item cust_svc + +Returns the customer service associated with this inventory item, if the +item has been used (see L<FS::cust_svc>). + +=cut + +sub cust_svc { + my $self = shift; + return '' unless $self->svcnum; + qsearchs( 'cust_svc', { 'svcnum' => $self->svcnum } ); +} + +=item agent + +Returns the associated agent for this event, if any, as an FS::agent object. + +=cut + +sub agent { + my $self = shift; + qsearchs('agent', { 'agentnum' => $self->agentnum } ); +} + +=back + +=head1 SUBROUTINES + +=over 4 + +=item process_batch_import + +=cut + +sub process_batch_import { + my $job = shift; + + my $opt = { 'table' => 'inventory_item', + #'params' => [ 'itembatch', 'classnum', ], + 'params' => [ 'classnum', 'agentnum', ], + 'formats' => { 'default' => [ 'item' ] }, + 'default_csv' => 1, + }; + + FS::Record::process_batch_import( $job, $opt, @_ ); + +} + +=back + +=head1 BUGS + +maybe batch_import should be a regular method in FS::inventory_class + +=head1 SEE ALSO + +L<inventory_class>, L<cust_svc>, L<FS::Record>, schema.html from the base +documentation. + +=cut + +1; + |