stalker.models.budget.BudgetEntry

class stalker.models.budget.BudgetEntry(budget=None, good=None, price=0, realized_total=0, amount=0.0, **kwargs)

Bases: stalker.models.entity.Entity, stalker.models.mixins.AmountMixin, stalker.models.mixins.UnitMixin

Manages entries in a Budget.

With BudgetEntries one can manage project budget entries one by one. Each entry shows one component of a bigger budget. Entries are generally a reflection of a Good instance and shows how many of that Good has been included in this Budget, and what was the discounted price of that Good.

Parameters:

• budget – The Budget that this entry is a part of.
• good – Stores a Good instance to carry all the cost/msrp/unit data from.
• price (float) – The decided price of this entry. This is generally bigger than the cost and should be also bigger than msrp but the person that is editing the budget which this entry is related to can decide to do a discount on this entry and give a different price. This attribute holds the proposed final price.
• realized_total (float) – This attribute is for holding the realized price of this entry. It can be the same number of the price multiplied by the amount or can be something else that reflects the reality. Generally it is for calculating the “service” cost/profit.
• amount (float) – Defines the amount of Good that is in consideration for this entry.

__init__(budget=None, good=None, price=0, realized_total=0, amount=0.0, **kwargs)

Methods

__init__([budget, good, price, …])

Attributes

amount
budget
budget_id
cost
created_by	The User who has created this object.
created_by_id	The id of the User who has created this entity.
date_created	A datetime.datetime instance showing the creation date and time of this object.
date_updated	A datetime.datetime instance showing the update date and time of this object.
description	Description of this object.
entity_groups
entity_id
entity_type
entry_id
generic_data	This attribute can hold any kind of data which exists in SOM.
generic_text	This attribute can hold any text.
good
good_id
html_class
html_style
id
metadata
msrp
name	Name of this object
nice_name	Nice name of this object.
notes	All the Notess attached to this entity.
plural_class_name	the plural name of this class
price
query
realized_total
tags	A list of tags attached to this object.
thumbnail
thumbnail_id
tjp_id	returns TaskJuggler compatible id
to_tjp	renders a TaskJuggler compliant string used for TaskJuggler
type	The type of the object.
type_id	The id of the Type of this entity.
unit
updated_by	The User who has updated this object.
updated_by_id	The id of the User who has updated this entity.

created_by

The User who has created this object.

created_by_id

The id of the User who has created this entity.

date_created

A datetime.datetime instance showing the creation date and time of this object.

date_updated

A datetime.datetime instance showing the update date and time of this object.

description

Description of this object.

generic_data

This attribute can hold any kind of data which exists in SOM.

generic_text

This attribute can hold any text.

name

Name of this object

nice_name

Nice name of this object.

It has the same value with the name (contextually) but with a different format like, all the white spaces replaced by underscores (“_”), all the CamelCase form will be expanded by underscore (_) characters and it is always lower case.

notes

All the Notess attached to this entity.

It is a list of Note instances or an empty list, setting it to None will raise a TypeError.

plural_class_name

the plural name of this class

tags

A list of tags attached to this object.

It is a list of Tag instances which shows the tags of this object

tjp_id

returns TaskJuggler compatible id

to_tjp

renders a TaskJuggler compliant string used for TaskJuggler integration. Needs to be overridden in inherited classes.

type

The type of the object.

It is a Type instance with a proper Type.target_entity_type.

type_id

The id of the Type of this entity. Mainly used by SQLAlchemy to create a Many-to-One relates between SimpleEntities and Types.

updated_by

The User who has updated this object.

updated_by_id

The id of the User who has updated this entity.