stalker.models.note.Note

class stalker.models.note.Note(content='', **kwargs)

Bases: stalker.models.entity.SimpleEntity

Notes for any of the SOM objects.

To leave notes in Stalker use the Note class.

Parameters:

• content – the content of the note
• attached_to – The object that this note is attached to.

__init__(content='', **kwargs)

Methods

__init__([content])

Attributes

content	The content of this Note instance.
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.
entities
entity_type
generic_data	This attribute can hold any kind of data which exists in SOM.
generic_text	This attribute can hold any text.
html_class
html_style
id
metadata	A collection of Table objects and their associated schema constructs.
name	Name of this object
nice_name	Nice name of this object.
note_id
plural_class_name	the plural name of this class
query	ORM-level SQL construction 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.
updated_by	The User who has updated this object.
updated_by_id	The id of the User who has updated this entity.

content

The content of this Note instance.

Content is a string representing the content of this Note, can be an empty.

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.

plural_class_name

the plural name of this class

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 an instance of Type 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.