Mercurial > libervia-pubsub
diff idavoll/storage.py @ 116:06bab3d2490d
Added more documentation.
author | Ralph Meijer <ralphm@ik.nu> |
---|---|
date | Fri, 08 Apr 2005 20:59:38 +0000 |
parents | 30c580286d27 |
children | 3e7a7426f518 |
line wrap: on
line diff
--- a/idavoll/storage.py Fri Apr 08 20:59:21 2005 +0000 +++ b/idavoll/storage.py Fri Apr 08 20:59:38 2005 +0000 @@ -84,13 +84,28 @@ class INode(Interface): """ """ def get_type(self): - """ """ + """ Get node's type. + + @return: C{'leaf'} or C{'collection'}. + """ def get_configuration(self): - """ """ + """ Get node's configuration. + + The configuration must at least have two options: + C{pubsub#persist_items}, and C{pubsub#deliver_payloads}. + + @return: L{dict} of configuration options. + """ def get_meta_data(self): - """ """ + """ Get node's meta data. + + The meta data must be a superset of the configuration options, and + also at least should have a C{pubsub#node_type} entry. + + @return: L{dict} of meta data. + """ def set_configuration(self, options): """ """