/ 
myco-framework-0.9
/ Myco::Base::Entity::SampleEntityBase

NAME

Myco::Base::Entity::SampleEntityBase - a Myco entity class.

-- thingies that do such and such

VERSION

$Revision: 1.2 $

DATE

$Date: 2003/12/19 21:52:03 $

SYNOPSIS

$obj = Myco::Base::Entity::SampleEntityBase->new;

# accessor usage
$obj->set_fooattrib("hello");
$value = $obj->get_fooattrib;

$obj->foometh();

DESCRIPTION

Blah blah blah... Blah blah blah... Blah blah blah... Blah blah blah blah blah... Blah blah...

ATTRIBUTES

Attributes may be initially set during object construction (with new()) but otherwise are accessed solely through accessor methods. Typical usage:

  • Set attribute value

    $obj->set_attributeName($value);

    Check functions (see Class::Tangram) perform data validation. If there is any concern that the set method might be called with invalid data then the call should be wrapped in an eval block to catch exceptions that would result.

  • Get attribute value

    $value = $obj->get_attributeName;

Available attributes are listed below, using syntax borrowed from UML class diagrams; for each showing the name, type, default initial value (if any), and, following that, a description.

-fooattrib: string = 'hello'

A whole lot of nothing

-barattrib: int

Almost, but not quite, something. [required: not undef]

COMMON ENTITY INTERFACE

constructor, accessors, and other methods -- as inherited from Myco::Base::Entity

ADDED CLASS / INSTANCE METHODS

foometh
Class->foometh(attribute => value, ...)

blah blah blah

barmeth
$instance->barmeth(attribute => $value, ...)

blah blah blah

LICENSE AND COPYRIGHT

Copyright (c) 2004 the myco project. All rights reserved. This software is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

Myco::Base::Entity::SampleEntityBase::Test, Myco::Base::Entity, Myco, Tangram, Class::Tangram, mkentity