Mercurial > libervia-pubsub
comparison 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 |
comparison
equal
deleted
inserted
replaced
115:97f10cfea28c | 116:06bab3d2490d |
---|---|
82 | 82 |
83 | 83 |
84 class INode(Interface): | 84 class INode(Interface): |
85 """ """ | 85 """ """ |
86 def get_type(self): | 86 def get_type(self): |
87 """ """ | 87 """ Get node's type. |
88 | |
89 @return: C{'leaf'} or C{'collection'}. | |
90 """ | |
88 | 91 |
89 def get_configuration(self): | 92 def get_configuration(self): |
90 """ """ | 93 """ Get node's configuration. |
94 | |
95 The configuration must at least have two options: | |
96 C{pubsub#persist_items}, and C{pubsub#deliver_payloads}. | |
97 | |
98 @return: L{dict} of configuration options. | |
99 """ | |
91 | 100 |
92 def get_meta_data(self): | 101 def get_meta_data(self): |
93 """ """ | 102 """ Get node's meta data. |
103 | |
104 The meta data must be a superset of the configuration options, and | |
105 also at least should have a C{pubsub#node_type} entry. | |
106 | |
107 @return: L{dict} of meta data. | |
108 """ | |
94 | 109 |
95 def set_configuration(self, options): | 110 def set_configuration(self, options): |
96 """ """ | 111 """ """ |
97 | 112 |
98 def get_affiliation(self, entity): | 113 def get_affiliation(self, entity): |