Ben Sommer

NAME

Myco::Entity::Event - a Myco entity class

SYNOPSIS

  use Myco;

  # Constructors. See Myco::Entity for more.
  my $obj = Myco::Entity::Event->new;

  # Accessors.
  my $value = $obj->get_fooattrib;
  $obj->set_fooattrib($value);

  $obj->save;
  $obj->destroy;

DESCRIPTION

An Event logging class for recording information and history for selected objects

COMMON ENTITY INTERFACE

Constructor, accessors, and other methods -- as inherited from Myco::Entity.

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_attribute($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_attribute;

A listing of available attributes follows:

kind

 type: int

The kind of the event. Could be 'Create', 'Delete', or 'Modify'

state

 type: perl_dump

A string dump of the Entity at time of Event creation.

entity_id

 type: int

The Tangram ID for the entity.

user_src

 type: ref

The Myco::User object that created (sourced) the entity.

entity_class

 type: string

The name of the class of the entity.

date

 type: rawdate

The date the event was occured.

entity

 type: transient

The entity object about which an event is being recorded. Intitalized with a reference to it.