TaskJuggler::JournalEntry

A JournalEntry stores some RichText strings to describe a status or a property of the project at a certain point in time. Additionally, the entry can contain a reference to a Resource as author and an alert level. The text is structured in 3 different elements, a headline, a short summary and a longer text segment. The headline is mandatory, the summary and details sections are optional.

Attributes

date[R]

headline[R]

property[R]

sourceFileInfo[R]

author[RW]

summary[RW]

details[RW]

alertLevel[RW]

timeSheetRecord[RW]

Public Class Methods

new(journal, date, headline, property, sourceFileInfo = nil) click to toggle source

Create a new JournalEntry object.

    # File lib/Journal.rb, line 28
28:     def initialize(journal, date, headline, property, sourceFileInfo = nil)
29:       # A reference to the Journal object this entry belongs to.
30:       @journal = journal
31:       # The date of the entry.
32:       @date = date
33:       # A very short description. Should not be longer than about 40
34:       # characters.
35:       @headline = headline
36:       # A reference to a PropertyTreeNode object.
37:       @property = property
38:       # Source file location of this entry of type SourceFileInfo
39:       @sourceFileInfo = sourceFileInfo
40:       # A reference to a Resource.
41:       @author = nil
42:       # An introductory or summarizing RichText paragraph.
43:       @summary = nil
44:       # A RichText of arbitrary length.
45:       @details = nil
46:       # The alert level.
47:       @alertLevel = 0
48:       # A reference to a time sheet record that was used to create this
49:       # JournalEntry object.
50:       @timeSheetRecord = nil
51: 
52:       # Add the new entry to the journal.
53:       @journal.addEntry(self)
54:     end

Home Classes Methods

In Files

Parent

Methods

Files

Class Index

TaskJuggler::JournalEntry

Attributes

Public Class Methods