SF.net SVN: ledger-smb:[4370] trunk/LedgerSMB/DBObject

[..hidden..]

Revision: 4370
          http://ledger-smb.svn.sourceforge.net/ledger-smb/?rev=4370&view=rev
Author:   einhverfr
Date:     2012-03-01 13:55:58 +0000 (Thu, 01 Mar 2012)
Log Message:
-----------
Beginnings of customer/vendor rewrite.  Haven't moved any of the actual working code over to this yet

Added Paths:
-----------
    trunk/LedgerSMB/DBObject/Entity/
    trunk/LedgerSMB/DBObject/Entity.pm

Added: trunk/LedgerSMB/DBObject/Entity.pm
===================================================================
--- trunk/LedgerSMB/DBObject/Entity.pm	                        (rev 0)
+++ trunk/LedgerSMB/DBObject/Entity.pm	2012-03-01 13:55:58 UTC (rev 4370)
@@ -0,0 +1,133 @@
+=head1 NAME
+
+LedgerSMB::DBObject::Entity -- Entity Management base classes for LedgerSMB
+
+=cut
+
+package LedgerSMB::DBObject::Entity;
+use Moose;
+
+=head1 SYNOPSYS
+
+This module anages basic entity management for persons and companies, both of which will
+likely inherit this class.
+
+=head1 INHERITS
+
+=over
+
+=item LedgerSMB::DBObject_Moose
+
+=back
+
+=cut
+
+extends 'LedgerSMB::DBObject_Moose';
+
+=head1 PROPERTIES
+
+=over
+
+=item id
+
+This is the internal, system id, which is a surrogate key.  This will be undefined when
+the entity has not yet been saved to the database and set once it has been saved or 
+retrieved.
+
+=cut
+
+has 'id' => (is => 'rw', isa => 'Maybe[Str]', required => '0');
+
+=item control_code
+
+The control code is the internal handling number for the operator to use to pull up 
+an entity,
+
+=cut
+
+has 'control_code' => (is => 'rw', isa => 'Str', required => 1, default => 'DEFAULT');
+
+=item name
+
+The unofficial name of the entity.  This is usually copied in from company.legal_name
+or prepared (using some sort of locale-specific logic) from person.first_name and
+person.last_name.
+
+=cut
+
+has 'name' => (is => 'rw', isa => 'Maybe[Str]');
+
+=item country_id
+
+ID of country of entiy.
+
+=cut
+
+has 'country_id' => (is => 'rw', isa => 'Int', required => '1', default => '0');
+
+=item country_name
+
+Name of country (optional)
+
+=cut
+
+has 'country_name' => (is => 'rw', isa => 'Maybe[Str]', required => '0');
+
+=item entity_class
+
+Primary class of entity.  This is mostly for reporting purposes.  See entity_class
+table in database for list of valid values, but 1 is for vendors, 2 for customers, 
+3 for employees, etc.
+
+=back
+
+=cut
+
+has 'entity_class' => (is => 'rw', isa => 'Int', required => '1', default => 0);
+
+=head1 METHODS
+
+=over
+
+=item get_locations
+
+Returns a list of locations for that entity
+
+=cut
+
+sub get_locations {
+    my ($self) = @_;
+    return $self->exec_method({funcname => 'entity__list_locations'}, add_dbo=> 1);
+}
+
+=item get_contacts
+
+Returns a list of contacts tied to the entity.
+
+=cut
+
+sub get_contacts{
+    my ($self) = @_;
+    return $self->exec_method({funcname => 'entity__list_contacts'}, add_dbo => 1);
+}
+
+=item get_notes
+
+Returns a list of notes tied to the entity.
+
+=cut
+
+sub get_notes{
+    my ($self) = @_;
+    return $self->exec_method({funcname => 'entity__list_notes'}, add_dbo => 1);
+}
+
+=head1 COPYRIGHT
+
+Copyright (C) 2012 The LedgerSMB Core Team.  This file may be reused under the
+conditions of the GNU GPL v2 or at your option any later version.  Please see the
+accompanying LICENSE.TXT for more information.
+
+=cut
+
+return 1;

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.