Ignore:
Timestamp:
7 Sep 2011, 08:03:07 (13 years ago)
Author:
Henrik Bettermann
Message:

Move IStudentsContainer to the top.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • main/waeup.sirp/trunk/src/waeup/sirp/students/interfaces.py

    r6665 r6692  
    77  year_range, lgas_vocab, CertificateSource, GenderSource,
    88  )
     9
     10class IStudentsContainer(IWAeUPObject):
     11    """An students container contains university students.
     12
     13    """
     14
     15    def addStudent(student):
     16        """Add an IStudent object and subcontainers.
     17
     18        """
     19
     20    def archive(id=None):
     21        """Create on-dist archive of students.
     22
     23        If id is `None`, all students are archived.
     24
     25        If id contains a single id string, only the respective
     26        students are archived.
     27
     28        If id contains a list of id strings all of the respective
     29        students types are saved to disk.
     30        """
     31
     32    def clear(id=None, archive=True):
     33        """Remove students of type given by 'id'.
     34
     35        Optionally archive the students.
     36
     37        If id is `None`, all students are archived.
     38
     39        If id contains a single id string, only the respective
     40        students are archived.
     41
     42        If id contains a list of id strings all of the respective
     43        student types are saved to disk.
     44
     45        If `archive` is ``False`` none of the archive-handling is done
     46        and respective students are simply removed from the
     47        database.
     48        """
    949
    1050class IStudentNavigation(IWAeUPObject):
     
    64104    """
    65105
    66 class IStudentsContainer(IWAeUPObject):
    67     """An students container contains university students.
    68 
    69     """
    70 
    71     def addStudent(student):
    72         """Add an IStudent object and subcontainers.
    73 
    74         """
    75 
    76     def archive(id=None):
    77         """Create on-dist archive of students.
    78 
    79         If id is `None`, all students are archived.
    80 
    81         If id contains a single id string, only the respective
    82         students are archived.
    83 
    84         If id contains a list of id strings all of the respective
    85         students types are saved to disk.
    86         """
    87 
    88     def clear(id=None, archive=True):
    89         """Remove students of type given by 'id'.
    90 
    91         Optionally archive the students.
    92 
    93         If id is `None`, all students are archived.
    94 
    95         If id contains a single id string, only the respective
    96         students are archived.
    97 
    98         If id contains a list of id strings all of the respective
    99         student types are saved to disk.
    100 
    101         If `archive` is ``False`` none of the archive-handling is done
    102         and respective students are simply removed from the
    103         database.
    104         """
    105 
    106106class IStudentStudyCourse(IWAeUPObject):
    107107    """A container for student study levels.
Note: See TracChangeset for help on using the changeset viewer.