src.clm.models.message.Message Class Reference

MESSAGE Model. More...

Classes
class	Meta

Public Member Functions
def	__unicode__
def	dict

Static Public Member Functions
def	create
def	get

Static Public Attributes
tuple	code = models.CharField(max_length=128)
	Code of this Message's template.
tuple	creation_date = models.DateTimeField(default=datetime.now)
	Message's creation date.
tuple	level = models.IntegerField()
	Importance level of the message (see also: src.common.states.message_levels)
tuple	params = models.CharField(max_length=2048)
	Params to insert into Message template.
tuple	user = models.ForeignKey(User)
	User whom this Message is targetted to.

Detailed Description

MESSAGE Model.

Message is an entity representing user-targeted communicates. Message has its level and content. Web interface renders Message's content based on it's code and params.

Definition at line 41 of file message.py.

Member Function Documentation

def src.clm.models.message.Message.__unicode__

(

self

)

Returns

(string) Message id

Definition at line 60 of file message.py.

def src.clm.models.message.Message.create (   data )

static

Parameters

data

(dict) fields: user_id (int) User id of the new messages creator level (int) importance level of the new message, see also: src.common.states.message_levels code (string) short code of the new message (locales translate short code into human-readable message, which is filled with data from params) params params to fill Message with (optional)

Method creates and returns new instance of Message.

Returns

(Message) instance of the newly created Message.

Definition at line 117 of file message.py.

def src.clm.models.message.Message.dict

(

self

)

Returns

(dict) Message's data
fields:

• message_id (int) id of this Message
• params params of this Message
• creation_date (datetime.datetime) creation date of this Message
• level (int) this Message's importance level importance, see also: src.common.states.message_levels
• code (string) short code of the Message (locales translate short code into human-readable message, which is filled with data from params)

Definition at line 76 of file message.py.

def src.clm.models.message.Message.get (   msg_id )

static

Parameters

msg_id

(int) id of the requested Message

Returns

(Message) instance of the requested Message

Exceptions

CLMException('message_get')

no such Message

Definition at line 94 of file message.py.

Member Data Documentation

tuple src.clm.models.message.Message.code = models.CharField(max_length=128)

static

Code of this Message's template.

Note

each instance of the model has corresponding non-static attribute

Definition at line 45 of file message.py.

tuple src.clm.models.message.Message.creation_date = models.DateTimeField(default=datetime.now)

static

Message's creation date.

Note

each instance of the model has corresponding non-static attribute

Definition at line 49 of file message.py.

tuple src.clm.models.message.Message.level = models.IntegerField()

static

Importance level of the message (see also: src.common.states.message_levels)

Note

each instance of the model has corresponding non-static attribute

Definition at line 51 of file message.py.

tuple src.clm.models.message.Message.params = models.CharField(max_length=2048)

static

Params to insert into Message template.

Note

each instance of the model has corresponding non-static attribute

Definition at line 47 of file message.py.

tuple src.clm.models.message.Message.user = models.ForeignKey(User)

static

User whom this Message is targetted to.

Note

each instance of the model has corresponding non-static attribute

Definition at line 43 of file message.py.

---

The documentation for this class was generated from the following file:

• clm/models/message.py