NAME

App::Dochazka::REST::Model::Activity - activity data model

VERSION

Version 0.145

SYNOPSIS

    use App::Dochazka::REST::Model::Activity;

    ...

DATA MODEL

Activities in the database

   CREATE TABLE activities (
       aid        serial PRIMARY KEY,
       code       varchar(32) UNIQUE NOT NULL,
       long_desc  text,
       remark     text
   )

Activity codes will always be in ALL CAPS thanks to a trigger (entitled code_to_upper) that runs the PostgreSQL upper function on the code before every INSERT and UPDATE on this table.

Activities in the Perl API

• constructor (spawn)

• basic accessors (aid, code, long_desc, remark)

• reset (recycles an existing object by setting it to desired state)

• insert (inserts object into database)

• update (updates database to match the object)

• delete (deletes record from database if nothing references it)

• load_by_aid (loads a single activity into an object)

• load_by_code (loads a single activity into an object)

App::Dochazka::REST::Model::Activity also exports some convenience functions:

• aid_by_code (given a code, returns AID)

For basic activity object workflow, see the unit tests in t/109-activity.t.

EXPORTS

This module provides the following exports:

aid_by_code - function

METHODS

spawn

Activity constructor. For details, see Employee.pm->spawn.

reset

Boilerplate.

Accessor methods

Boilerplate.

aid

Accessor method.

code

Accessor method.

long_desc

Accessor method.

remark

Accessor method.

insert

Instance method. Takes the object, as it is, and attempts to insert it into the database. On success, overwrites object attributes with field values actually inserted. Returns a status object.

update

Instance method. Assuming that the object has been prepared, i.e. the AID corresponds to the activity to be updated and the attributes have been changed as desired, this function runs the actual UPDATE, hopefully bringing the database into line with the object. Overwrites all the object's attributes with the values actually written to the database. Returns status object.

delete

Instance method. Assuming the AID really corresponds to the activity to be deleted, this method will execute the DELETE statement in the database. It won't succeed if the activity has any intervals associated with it. Returns a status object.

load_by_aid

Loads activity from database, by the AID provided in the argument list, into a newly-spawned object. The code must be an exact match. Returns a status object: if the object is loaded, the code will be 'DISPATCH_RECORDS_FOUND' and the object will be in the payload; if the AID is not found in the database, the code will be 'DISPATCH_NO_RECORDS_FOUND'. A non-OK status indicates a DBI error.

load_by_code

Analogous method to "load_by_aid".

FUNCTIONS

The following functions are not object methods.

aid_by_code

Given a code, attempt to retrieve the corresponding AID. Returns AID or undef on failure.

AUTHOR

Nathan Cutler, <presnypreklad@gmail.com>

cpanm App::Dochazka::REST

perl -MCPAN -e shell
install App::Dochazka::REST