Skip to content

Commit 3a06ccd

Browse files
author
Richard Jones
committed
add "actor" to design
1 parent 6a89b61 commit 3a06ccd

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

doc/design.txt

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -693,13 +693,15 @@ superseder hyperdb.Multilink("issue")
693693
=========== ==========================
694694

695695
Also, two Date properties named "creation" and "activity" are fabricated
696-
by the Roundup database layer. By "fabricated" we mean that no such
696+
by the Roundup database layer. Two user Link properties, "creator" and
697+
"actor" are also fabricated. By "fabricated" we mean that no such
697698
properties are actually stored in the hyperdatabase, but when properties
698-
on issues are requested, the "creation" and "activity" properties are
699-
made available. The value of the "creation" property is the date when an
700-
issue was created, and the value of the "activity" property is the date
701-
when any property on the issue was last edited (equivalently, these are
702-
the dates on the first and last records in the issue's journal).
699+
on issues are requested, the "creation"/"creator" and "activity"/"actor"
700+
properties are made available. The value of the "creation"/"creator"
701+
properties relate to issue creation, and the value of the "activity"/
702+
"actor" properties relate to the last editing of any property on the issue
703+
(equivalently, these are the dates on the first and last records in the
704+
issue's journal).
703705

704706

705707
Roundupdb Interface Specification
@@ -720,8 +722,8 @@ hyperdatabase, except for the following changes and additional methods::
720722
def set(self, **propvalues):
721723
def retire(self, itemid):
722724
"""These operations trigger detectors and can be vetoed.
723-
Attempts to modify the "creation" or "activity" properties
724-
cause a KeyError.
725+
Attempts to modify the "creation", "creator", "activity"
726+
properties or "actor" cause a KeyError.
725727
"""
726728

727729
# New methods:
@@ -737,13 +739,14 @@ hyperdatabase, except for the following changes and additional methods::
737739
"""The newly-created class automatically includes the
738740
"messages", "files", "nosy", and "superseder" properties.
739741
If the 'properties' dictionary attempts to specify any of
740-
these properties or a "creation" or "activity" property, a
741-
ValueError is raised."""
742+
these properties or a "creation", "creator", "activity" or
743+
"actor" property, a ValueError is raised."""
742744

743745
def get(self, itemid, propname):
744746
def getprops(self):
745747
"""In addition to the actual properties on the item, these
746-
methods provide the "creation" and "activity" properties."""
748+
methods provide the "creation", "creator", "activity" and
749+
"actor" properties."""
747750

748751
# New methods:
749752

@@ -1611,6 +1614,7 @@ Changes to this document
16111614
nature of the Class.
16121615
- New Templating
16131616
- Access Controls
1617+
- Added "actor" property
16141618

16151619
------------------
16161620

0 commit comments

Comments
 (0)