students – Students Section Components Package

(see also: Submodules)

This package contains everything regarding students.

class waeup.kofa.students.Student

This is a student container for the various objects owned by students.

__doc__ = 'This is a student container for the various objects\n owned by students.\n '

__implemented__ = <implementedBy waeup.kofa.students.student.Student>

__init__()

__module__ = 'waeup.kofa.students.student'

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

For example:

>>> from zope.interface import Interface
>>> class IFooFactory(Interface):
...     pass
>>> class IFoo(Interface):
...     pass
>>> class C(object):
...     implements(IFoo)
...     classProvides(IFooFactory)
>>> [i.getName() for i in C.__provides__]
['IFooFactory']

>>> [i.getName() for i in C().__provides__]
['IFoo']

adm_code

PWD Activation Code (computed attribute)

before_payment

certcode

clearance_locked

clr_code

CLR Activation Code (computed attribute)

current_level

current_mode

current_session

current_verdict

date_of_birth

Date of Birth (computed attribute)

depcode

display_fullname

email

Email (computed attribute)

employer

Employer (computed attribute)

entry_mode

entry_session

faccode

firstname

First Name (computed attribute)

flash_notice

Flash Notice (computed attribute)

fullname

getParentsPassword()

Check if a parents password has been set and if it is not expired.

Return the parents password if valid, None otherwise. Unset the parents password and replace roles if expired.

getTempPassword()

Check if a temporary password has been set and if it is not expired.

Return the temporary password if valid, None otherwise. Unset the temporary password if expired.

history

is_fresh

is_postgrad

is_special_postgrad

lastname

Last Name (Surname) (computed attribute)

matric_number

Matriculation Number (computed attribute)

middlename

Middle Name (computed attribute)

nationality

Nationality (computed attribute)

officer_comment

Officer’s Comment (computed attribute)

parents_email

Parents’ Email (computed attribute)

perm_address

Permanent Address (computed attribute)

personal_data_expired

personal_updated

Updated (computed attribute)

phone

Phone (computed attribute)

reg_number

Registration Number (computed attribute)

revert_transfer()

Revert previous transfer.

setParentsPassword(password)

Set a temporary password (LDAP-compatible) SSHA encoded for parents.

setTempPassword(user, password)

Set a temporary password (LDAP-compatible) SSHA encoded for officers.

sex

Gender (computed attribute)

state

student

student_id

Student Id (computed attribute)

studycourse_locked

suspended

Account suspended (computed attribute)

suspended_comment

Reasons for Deactivation (computed attribute)

transcript_enabled

transfer(certificate, current_session=None, current_level=None, current_verdict=None, previous_verdict=None)

Creates a new studycourse and backups the old one.

translated_state

writeLogMessage(view, message)

class waeup.kofa.students.StudentFactory

A factory for students.

__call__(*args, **kw)

__doc__ = 'A factory for students.\n '

__implemented__ = <implementedBy waeup.kofa.students.student.StudentFactory>

__module__ = 'waeup.kofa.students.student'

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

For example:

>>> from zope.interface import Interface
>>> class IFooFactory(Interface):
...     pass
>>> class IFoo(Interface):
...     pass
>>> class C(object):
...     implements(IFoo)
...     classProvides(IFooFactory)
>>> [i.getName() for i in C.__provides__]
['IFooFactory']

>>> [i.getName() for i in C().__provides__]
['IFoo']

description = u'This factory instantiates new student instances.'

getInterfaces()

title = (u'Create a new student.',)

class waeup.kofa.students.StudentsContainer

The node containing the student models

__doc__ = '\n The node containing the student models\n '

__implemented__ = <implementedBy waeup.kofa.students.container.StudentsContainer>

__module__ = 'waeup.kofa.students.container'

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

For example:

>>> from zope.interface import Interface
>>> class IFooFactory(Interface):
...     pass
>>> class IFoo(Interface):
...     pass
>>> class C(object):
...     implements(IFoo)
...     classProvides(IFooFactory)
>>> [i.getName() for i in C.__provides__]
['IFooFactory']

>>> [i.getName() for i in C().__provides__]
['IFoo']

_curr_stud_id = 1000000

addStudent(student)

Add a student with subcontainers.

logger_filename = 'students.log'

logger_name = 'waeup.kofa.${sitename}.students'

unique_student_id

A unique student id.

The student id returned is guaranteed to be unique. It consists of some prefix (normally a single letter) followed by a number with at least 7 digits.

Once a student id was issued, it won’t be issued again.

Obtaining a student id is currently not thread-safe but can be made easily by enabling commented lines.

class waeup.kofa.students.StudentStudyCourse

This is a container for study levels.

__doc__ = 'This is a container for study levels.\n '

__implemented__ = <implementedBy waeup.kofa.students.studycourse.StudentStudyCourse>

__init__()

__module__ = 'waeup.kofa.students.studycourse'

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

For example:

>>> from zope.interface import Interface
>>> class IFooFactory(Interface):
...     pass
>>> class IFoo(Interface):
...     pass
>>> class C(object):
...     implements(IFoo)
...     classProvides(IFooFactory)
>>> [i.getName() for i in C.__provides__]
['IFooFactory']

>>> [i.getName() for i in C().__provides__]
['IFoo']

addStudentStudyLevel(cert, studylevel, course_category=None)

Add a study level object.

certificate

Certificate (computed attribute)

current_level

Current Level (computed attribute)

current_session

Current Session (computed attribute)

current_verdict

Current Verdict (computed attribute)

entry_mode

Entry Mode (computed attribute)

entry_session

Entry Session (computed attribute)

getTranscriptData()

Get a sorted list of dicts with level and course ticket data.

This method is used for transcripts.

is_current

is_postgrad

is_previous

is_special_postgrad = False

next_session_allowed

previous_verdict

Previous Verdict (computed attribute)

student

writeLogMessage(view, message)

class waeup.kofa.students.StudentPaymentsContainer

This is a container for student payments.

__doc__ = 'This is a container for student payments.\n '

__implemented__ = <implementedBy waeup.kofa.students.payments.StudentPaymentsContainer>

__init__()

__module__ = 'waeup.kofa.students.payments'

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

For example:

>>> from zope.interface import Interface
>>> class IFooFactory(Interface):
...     pass
>>> class IFoo(Interface):
...     pass
>>> class C(object):
...     implements(IFoo)
...     classProvides(IFooFactory)
>>> [i.getName() for i in C.__provides__]
['IFooFactory']

>>> [i.getName() for i in C().__provides__]
['IFoo']

certificate

student

writeLogMessage(view, message)

class waeup.kofa.students.StudentAccommodation

This is a container for bed tickets.

__doc__ = 'This is a container for bed tickets.\n '

__implemented__ = <implementedBy waeup.kofa.students.accommodation.StudentAccommodation>

__init__()

__module__ = 'waeup.kofa.students.accommodation'

__provides__

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that we can get declarations for objects without instance-specific interfaces a bit quicker.

For example:

>>> from zope.interface import Interface
>>> class IFooFactory(Interface):
...     pass
>>> class IFoo(Interface):
...     pass
>>> class C(object):
...     implements(IFoo)
...     classProvides(IFooFactory)
>>> [i.getName() for i in C.__provides__]
['IFooFactory']

>>> [i.getName() for i in C().__provides__]
['IFoo']

addBedTicket(bedticket)

Add a bed ticket object.

desired_hostel

Desired Hostel (computed attribute)

student

writeLogMessage(view, message)

class waeup.kofa.students.StudentPrincipalRoleManager(context)

__doc__ = None

__module__ = 'waeup.kofa.students.dynamicroles'

extra_attrib = 'certificate'

getRolesForPrincipal(principal_id)

Get roles for principal with id principal_id.

See waeup.kofa.applicants.dynamicroles.ApplicantPrincipalRoleManager for further information.

rolename_mapping = {'waeup.local.ClearanceOfficer': 'waeup.StudentsClearanceOfficer', 'waeup.local.LocalWorkflowManager': 'waeup.WorkflowManager', 'waeup.local.LocalStudentsManager': 'waeup.StudentsManager', 'waeup.local.ReportsOfficer': 'waeup.ReportsOfficer', 'waeup.local.TranscriptOfficer': 'waeup.TranscriptOfficer', 'waeup.local.TranscriptSignee': 'waeup.TranscriptSignee'}

subcontainer = 'studycourse'

Submodules

This package bundles the following modules:

• students.student - Student Components
• students.studycourse - Student Study Course Components
• students.studylevel - Student Study Level Components
• students.authentication - Student Authentication Components
• students.permissions - Student Permissions
• students.batching - Student Import and Export Components
• students.browser - Students UI Components
• students.viewlets - Student Browser Viewlets
• students.catalog - Students Catalog Components
• students.container - Students Container
• students.dynamicroles - Dynamic Roles Components
• students.payments - Student Payments
• students.accommodation - Student Accommodation Components
• students.workflow - Student Workflow
• students.vocabularies - Student Vocabularies
• students.utils - Student Utilities
• students.interfaces - Students Related Interfaces