Mercurial Repository: p/roundup/code: doc/design.txt comparison

comparison doc/design.txt @ 1091:d870139aeb5c

more doc

author	Richard Jones <richard@users.sourceforge.net>
date	Tue, 10 Sep 2002 00:45:46 +0000
parents	43ab730ee194
children	8dd4f736370b

comparison

equal deleted inserted replaced

-:9b910e8d987d
+:d870139aeb5c
 >>> Interval("  3w  1  d  2:00")
 <Interval 22d 2:00>
 >>> Date(". + 2d") - Interval("3w")
 <Date 2000-06-07.00:34:02>
-Nodes and Classes
+Items and Classes
 ~~~~~~~~~~~~~~~~~
-Nodes contain data in properties.  To Python, these
+Items contain data in properties.  To Python, these
 properties are presented as the key-value pairs of a dictionary.
 Each item belongs to a class which defines the names
 and types of its properties.  The database permits the creation
 and modification of classes as well as items.
 the item's numeric identifier.
 For example, if "spam" and "eggs" are classes, the first
 item created in class "spam" has id 1 and designator "spam1".
 The first item created in class "eggs" also has id 1 but has
-the distinct designator "eggs1".  Node designators are
+the distinct designator "eggs1".  Item designators are
 conventionally enclosed in square brackets when mentioned
 in plain text.  This permits a casual mention of, say,
 "[patch37]" in an e-mail message to be turned into an active
 hyperlink.
 may collide with the names of existing properties, or a ValueError
 is raised before any properties have been added.
 """
 def getitem(self, itemid, cache=1):
-''' Return a Node convenience wrapper for the item.
+''' Return a Item convenience wrapper for the item.
 'itemid' must be the id of an existing item of this class or an
 IndexError is raised.
 'cache' indicates whether the transaction cache should be queried
 for the item. If the item has been modified and you need to
 determine what its values prior to modification are, you need to
 set cache=0.
 '''
-class Node:
+class Item:
 ''' A convenience wrapper for the given item. It provides a mapping
 interface to a single item's properties
 '''
 Hyperdatabase Implementations
 Roles. These definitions are not persistent - they're defined when the
 application initialises.
 There will be two levels of Permission. The Class level permissions define
 logical permissions associated with all items of a particular class (or all
-classes). The Node level permissions define logical permissions associated
+classes). The Item level permissions define logical permissions associated
 with specific items by way of their user-linked properties.
 Access Control Interface Specification
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 def hasPermission(self, permission, userid, classname=None):
 ''' Look through all the Roles, and hence Permissions, and see if
 "permission" is there for the specified classname.
 '''
-def hasNodePermission(self, classname, itemid, **propspec):
+def hasItemPermission(self, classname, itemid, **propspec):
 ''' Check the named properties of the given item to see if the
 userid appears in them. If it does, then the user is granted
 this permission check.
 'propspec' consists of a set of properties and values that
 user.create(username="admin", password=Password(adminpw),
 address=config.ADMIN_EMAIL, roles='Admin')
 user.create(username="anonymous", roles='Anonymous')
 Then in the code that matters, calls to ``hasPermission`` and
-``hasNodePermission`` are made to determine if the user has permission
+``hasItemPermission`` are made to determine if the user has permission
 to perform some action::
 if db.security.hasPermission('issue', 'Edit', userid):
 # all ok
-if db.security.hasNodePermission('issue', itemid, assignedto=userid):
+if db.security.hasItemPermission('issue', itemid, assignedto=userid):
 # all ok
 Code in the core will make use of these methods, as should code in auditors in
 custom templates. The htmltemplate will implement a new tag, ``<require>``
 which has the form::
 where:
 - the permission attribute gives a comma-separated list of permission names.
 These are checked in turn using ``hasPermission`` and requires one to
 be OK.
-- the other attributes are lookups on the item using ``hasNodePermission``. If
+- the other attributes are lookups on the item using ``hasItemPermission``. If
 the attribute value is "$userid" then the current user's userid is tested.
 Any of these tests must pass or the ``<require>`` check will fail. The section
 of html within the side of the ``<else>`` that fails is remove from processing.

Mercurial > p > roundup > code

comparison doc/design.txt @ 1091:d870139aeb5c