stalker.models.department.Department

class stalker.models.department.Department(users=None, **kwargs)

Bases: stalker.models.entity.Entity

The departments that forms the studio itself.

The information that a Department object holds is like:

• The members of the department
• and all the other things those are inherited from the AuditEntity class

Two Department object considered the same if they have the same name, the the users list is not important, a “Modeling” department should of course be the same with another department which has the name “Modeling” again.

so creating a department object needs the following parameters:

Parameters:users – it can be an empty list, so one department can be created without any member in it. But this parameter should be a list of User objects.

__init__(users=None, **kwargs)

Methods

__init__([users])

Attributes

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.
department_id
description	Description of this object.
entity_id
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.
notes	All the Notess attached to this entity.
plural_class_name	the plural name of this class
query	ORM-level SQL construction object.
tags	A list of tags attached to this object.
thumbnail
thumbnail_id
tjp_id	returns TaskJuggler compatible id
to_tjp	outputs a TaskJuggler compatible string
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.
user_role	List of users representing the members of this department.
users	A descriptor that presents a read/write view of an object attribute.

user_role

List of users representing the members of this department.

to_tjp

outputs a TaskJuggler compatible string

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

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.