Bases: stalker.models.entity.Entity, stalker.models.mixins.TargetEntityTypeMixin
Type specific list of Status instances.
Holds multiple Statuses to be used as a choice list for several other classes.
A StatusList can only be assigned to only one entity type. So a Project can only have one suitable StatusList object which is designed for Project entities.
The list of statuses in StatusList can be accessed by using a list like indexing and it also supports string indexes only for getting the item, you can not set an item with string indices:
>>> from stalker import Status, StatusList
>>> status1 = Status(name="Complete", code="CMPLT")
>>> status2 = Status(name="Work in Progress", code="WIP")
>>> status3 = Status(name="Pending Review", code="PRev")
>>> a_status_list = StatusList(name="Asset Status List",
statuses=[status1, status2, status3],
target_entity_type="Asset")
>>> a_status_list[0]
<Status (Complete, CMPLT)>
>>> a_status_list["complete"]
<Status (Complete, CMPLT)>
>>> a_status_list["WIP"]
<Status (Work in Progress, WIP)>
Parameters: |
|
---|
Methods
__init__([statuses, target_entity_type]) |
Attributes
created_by | The User who has created this object. |
created_by_id | The id of the User who has created |
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_id | |
entity_type | |
generic_data | This attribute can hold any kind of data which exists in SOM. |
id | |
metadata | A collection of Table objects and their associated schema |
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. |
status_list_id | |
statuses | list of Status objects, showing the possible statuses |
tags | A list of tags attached to this object. |
target_entity_type | The entity type which this object is valid for. |
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 |
A datetime.datetime instance showing the creation date and time of this object.
A datetime.datetime instance showing the update date and time of this object.
Description of this object.
This attribute can hold any kind of data which exists in SOM.
Name of this object
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.
All the Notess attached to this entity.
It is a list of Note instances or an empty list, setting it None will raise a TypeError.
the plural name of this class
A list of tags attached to this object.
It is a list of Tag instances which shows the tags of this object
The entity type which this object is valid for.
Usually it is set to the TargetClass directly.
returns TaskJuggler compatible id
renders a TaskJuggler compliant string used for TaskJuggler integration. Needs to be overridden in inherited classes.
The type of the object.
It is an instance of Type with a proper target_entity_type.