Changeset 3848 for waeup

Timestamp:

16 Jan 2009, 12:22:52 (16 years ago)

Author:

uli

Message:

New interfaces.

File:

• waeup/branches/ulif-rewrite/src/waeup/interfaces.py (modified) (2 diffs)

waeup/branches/ulif-rewrite/src/waeup/interfaces.py

@@ -4 +4 @@
 from zope import schema
 
-class IUniversity(Interface):
+class IWAeUPObject(Interface):
+    """A WAeUP object.
+    """
+
+class IUniversity(IWAeUPObject):
     """Representation of a university.
     """
@@ -13 +17 @@
         )
 
-class IStudentContainer(Interface):
+class IWAeUPContainer(IWAeUPObject):
+    """A container for WAeUP objects.
+    """
+    
+class IStudentContainer(IWAeUPContainer):
     """A container for StudentObjects.
     """
 
-class IHostelContainer(Interface):
+class IHostelContainer(IWAeUPContainer):
     """A container for hostels.
     """
 
-class IFacultyContainer(Interface):
+class IFacultyContainer(IWAeUPContainer):
     """A container for faculties.
     """
+class IWAeUPExporter(Interface):
+    """An exporter for objects.
+    """
+    def export(obj, filepath=None):
+        """Export by pickling.
+
+        Returns a file-like object containing a representation of `obj`.
+
+        This is done using `pickle`. If `filepath` is ``None``, a
+        `cStringIO` object is returned, that contains the saved data.
+        """
+
+class IWAeUPXMLExporter(Interface):
+    """An XML exporter for objects.
+    """
+    def export(obj, filepath=None):
+        """Export as XML.
+
+        Returns an XML representation of `obj`.
+
+        If `filepath` is ``None``, a StringIO` object is returned,
+        that contains the transformed data.
+        """