Changeset 42 for LATMOS-Accounts/lib/LATMOS/Accounts/Bases/Objects.pm

Timestamp:

04/25/09 09:04:34 (15 years ago)

Author:

nanardon

Message:

• dont provide mandatory function anymore

File:

• LATMOS-Accounts/lib/LATMOS/Accounts/Bases/Objects.pm (modified) (8 diffs)

LATMOS-Accounts/lib/LATMOS/Accounts/Bases/Objects.pm

@@ -26 +26 @@
 List object supported by this module existing in base $base
 
-=cut
-
-sub list {
-    my ($class) = @_;
-    return;
-}
+Must be provide by object class
+
+    sub list {
+        my ($class) = @_;
+    }
+
+=cut
 
 =head2 new($base, $id)
@@ -64 +65 @@
 }
 
+=head2 _create($class, $base, $id, %data)
+
+Must create a new object in database.
+
+Is called if underling base does not override create_object
+
+    sub _create(
+        my ($class, $base, $id, %data)
+    }
+
+=cut
+
 =head2 type
 
@@ -85 +98 @@
 }
 
+=head2 list_canonical_fields
+
+Object shortcut to get the list of field supported by the object.
+
+=cut
+
+sub list_canonical_fields {
+    my ($self) = @_;
+    $self->base->list_canonical_fields($self->type);
+}
+
 =head2 _canonical_fields
 
@@ -90 +114 @@
 
 Notice this query will always come from the upstream data base,
-this function is just a ficility to store data in the module, but the
+this function is just a facility to store data in the module, but the
 underling database can reply themself.
 
+Is call if underling base doesn't override list_canonical_fields()
+
 See list_canonical_fields().
 
-=cut
-
-sub _canonical_fields { 
-    my ($self) = @_;
-    return;
-}
+    sub _canonical_fields { 
+        my ($self) = @_;
+    }
+
+=cut
 
 =head2 _get_fields_name($field)
@@ -106 +131 @@
 Return the fields name for canonical field $field
 
-=cut
-
-sub _get_field_name {
-    my ($self, $field) = @_;
-    return;
-}
+    sub _get_field_name {
+        my ($self, $field) = @_;
+    }
+
+=cut
 
 =head2 get_field($field)
@@ -117 +141 @@
 Return the value for $field, must be provide by data base.
 
-=cut
-
-sub get_field { return }
+    sub get_field {
+        my ($self, $field)
+    }
+
+=cut
 
 =head2 get_c_fields($cfield)
 
-Return the value for canonical field $cfield
+Return the value for canonical field $cfield.
+
+Call driver specific get_field_name() and get_field()
 
 =cut
@@ -137 +165 @@
 Set values for this object. %data is a list or peer field => values.
 
-=cut
-
-sub set_fields {
-    return;
-}
-
-=head2 set_fields(%data)
+    sub set_fields {
+        my ($self, %data) = @_;
+    }
+
+=cut
+
+=head2 set_c_fields(%data)
 
 Set values for this object. %data is a list or peer 
@@ -194 +222 @@
 at your option, any later version of Perl 5 you may have available.
 
-
-=cut
+=cut