Changeset 12725 for main/waeup.ikoba/branches/uli-payments/src/waeup/ikoba/payments/interfaces.py

Timestamp:

11 Mar 2015, 08:56:18 (10 years ago)

Author:

uli

Message:

Add interface for payables.

File:

• main/waeup.ikoba/branches/uli-payments/src/waeup/ikoba/payments/interfaces.py (modified) (1 diff)

main/waeup.ikoba/branches/uli-payments/src/waeup/ikoba/payments/interfaces.py

@@ -146 +146 @@
 class IPayableFinder(Interface):
     """Finds payables.
+
+    For each type of content you want to make payable, you should
+    define an IPayableFinder that can lookup payables in the
+    site.
+
+    This enables access from payments (which store payable ids only)
+    to arbitrary content objects (for which a payable finder is
+    registered under some name).
+
+    The other way round (getting an id and other relevant data from
+    any content object) is ensured by IPayable adapters.
     """
     def get_payable_by_id(item_id):
         """Get an item by its Id, or none.
         """
+
+
+class IPayable(Interface):
+    """Something that can be payed.
+
+    Designed to serve as adapter. IPayables turn arbitrary content
+    objects into something with a standarized interfaces for use with
+    payments.
+    """
+    payable_id = schema.TextLine(
+        title=u'ID of a payable',
+        description=(u'It should be possible to lookup the payable id '
+                     u'by some registered IPayableFinder later on'),
+        required=True,
+        readonly=True,
+        )
+
+    title = schema.TextLine(
+        title=u'Title',
+        description=u'A short description of the payed item.',
+        required=True,
+        default=u'',
+        readonly=True,
+        )