/ 
Class-Scaffold-1.102280
River stage one • 1 direct dependent • 1 total dependent
/ Class::Scaffold::BusinessObject

NAME

Class::Scaffold::BusinessObject - Base class for framework business objects

VERSION

version 1.102280

METHODS

apply_instruction_container

This method will be called with an instruction container object and is expected to apply the instructions contained therein to the business object. In this base class the method does nothing; subclasses will implement it.

assert_key

Checks that the business object defines a key. If it does not, an exception is raised.

check

This method is given an exception container, which it fills with exceptions that arise from checking. Since we're dealing exclusively with value objects, we can check for valid characters, field lengths, some wellformedness and validity (in case of email value objects, for example), all from within the business objects themselves. By moving part of the checking code into the objects themselves we make the policy stage more generic. Other registries can simply define business objects in terms of different value objects.

store

If the business object has a defined key, it will be updated, otherwise it will be stored. The business object will have a key when it has been stored or originally read from the storage. New business objects that haven't been stored yet won't have a key, so they will be inserted.

used_objects

Returns a value pair where the first value is the object type and the second value is the business object's key.

FIXME: This method is used in conjunction with keywords in Registry-Core and might be better placed in that distribution.

INSTALLATION

See perlmodinstall for information and options on installing Perl modules.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests through the web interface at http://rt.cpan.org.

AVAILABILITY

The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit http://www.perl.com/CPAN/ to find a CPAN site near you, or see http://search.cpan.org/dist/Class-Scaffold/.

The development version lives at http://github.com/hanekomu/Class-Scaffold/. Instead of sending patches, please fork this project using the standard git and github infrastructure.

AUTHORS

  • Marcel Gruenauer <marcel@cpan.org>

  • Florian Helmberger <fh@univie.ac.at>

  • Achim Adam <ac@univie.ac.at>

  • Mark Hofstetter <mh@univie.ac.at>

  • Heinz Ekker <ek@univie.ac.at>

COPYRIGHT AND LICENSE

This software is copyright (c) 2008 by Marcel Gruenauer.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.