students.interfaces - Students Related Interfaces

class waeup.kofa.students.interfaces.BalancePaymentCategorySource[source]

Bases: waeup.kofa.interfaces.ContextualDictSourceFactoryBase

A source that delivers all selectable items of balance payments.

DICT_NAME = 'BALANCE_PAYMENT_CATEGORIES'

name of dict to deliver from kofa utils.

__doc__ = 'A source that delivers all selectable items of balance payments.\n '
__module__ = 'waeup.kofa.students.interfaces'
interface waeup.kofa.students.interfaces.IBedTicket[source]

Extends: waeup.kofa.interfaces.IKofaObject

A representation of accommodation booking data.

booking_date

Booking Date

bed_type

Requested Bed Type

bed_coordinates
bed

The bed object

display_coordinates

Allocated Bed

booking_session

Session

getSessionString()

Returns the title of academic_sessions_vocab term of the session when the bed was booked.

maint_payment_made

True if maintenance payment is made

booking_code

Booking Activation Code

interface waeup.kofa.students.interfaces.ICSVStudentExporter[source]

Extends: waeup.kofa.interfaces.ICSVExporter

A regular ICSVExporter that additionally supports exporting data from a given student object.

get_selected(site, selected)

Get set of selected students.

export_student(student, filepath=None)

Export data for a given student.

export_selected(site, filepath=None, **kw)

Export data for selected set of students.

get_filtered(site, **kw)

Get a filtered set of students.

export_filtered(site, filepath=None, **kw)

Export data for filtered set of students.

interface waeup.kofa.students.interfaces.ICourseTicket[source]

Extends: waeup.kofa.interfaces.IKofaObject

A representation of course ticket data.

code

Code of the original course

mandatory

Required

removable_by_student

True if student is allowed to remove the ticket

weight

Weight calculated from total score

editable_by_lecturer

True if lecturer is allowed to edit the ticket

grade

Grade calculated from total score

semester

Semester/Term

dcode

Department Code

title

Title

level_session

Session of the study level the ticket has been added to

outstanding

Outstanding Course

carry_over

Carry-over Course

course_category

Course Category

fcode

Faculty Code

score

Score

total_score
passmark

Passmark

certcode

Certificate code of the study course

credits

Credits

level

Level value of the study level the ticket has been added to

automatic

Automatical Creation

interface waeup.kofa.students.interfaces.ICourseTicketAdd[source]

Extends: waeup.kofa.interfaces.IKofaObject

An interface for adding course tickets.

course

Course

interface waeup.kofa.students.interfaces.ICourseTicketImport[source]

Extends: waeup.kofa.students.interfaces.ICourseTicket

An interface for importing course results and nothing more.

score

Score

level_session

Level Session

interface waeup.kofa.students.interfaces.IPGStudentClearance[source]

Extends: waeup.kofa.students.interfaces.IUGStudentClearance

Representation of postgraduate student clearance data.

employer

Employer

interface waeup.kofa.students.interfaces.IStudent[source]

Extends: waeup.kofa.students.interfaces.IStudentBase, waeup.kofa.students.interfaces.IUGStudentClearance, waeup.kofa.students.interfaces.IPGStudentClearance, waeup.kofa.students.interfaces.IStudentPersonal, waeup.kofa.students.interfaces.IStudentTranscript

Representation of a student.

interface waeup.kofa.students.interfaces.IStudentAccommodation[source]

Extends: waeup.kofa.interfaces.IKofaObject

A container for student accommodation objects.

addBedTicket(bedticket)

Add a bed ticket object.

desired_hostel

Desired Hostel

interface waeup.kofa.students.interfaces.IStudentBalancePayment[source]

Extends: waeup.kofa.interfaces.IKofaObject

An interface for adding balances.

balance_amount

Balance Amount

Balance in Naira

balance_session

Payment Session

p_category

Payment Category

balance_level

Payment Level

interface waeup.kofa.students.interfaces.IStudentBase[source]

Extends: waeup.kofa.interfaces.IKofaObject

Representation of student base data.

flash_notice

Flash Notice

This single-line message will be shown in a flash box.

setTempPassword(user, password)

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

sex

Sex

matric_number

Matriculation Number

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.

temp_password

Dictionary with user name, timestamp and encrypted password

adm_code

PWD Activation Code

suspended

Account suspended

before_payment

True if no previous payment has to be made

reg_number

Registration Number

transfer(certificate, current_session, current_level, current_verdict)

Creates a new studycourse and backups the old one.

current_session

Current session

entry_session

Entry session

state

Registration state

lastname

Last Name (Surname)

is_fresh

True if fresh student

display_fullname

Fullname as displayed on pages

current_verdict

Current verdict

translated_state

Real name of the registration state

firstname

First Name

middlename

Middle Name

current_level

Current level

revert_transfer()

Revert previous transfer.

certcode

Certificate code of any chosen study course

phone

Phone

suspended_comment

Reasons for Deactivation

This message will be shown if and only if deactivated students try to login.

password

Encrypted password

is_special_postgrad

True if special postgraduate student

depcode

Department code of any chosen study course

transcript_enabled

True if transcript processing is enabled

clearance_locked

True if clearance form is locked

personal_data_expired

True if personal data expired

is_postgrad

True if postgraduate student

current_mode

Current mode

faccode

Faculty code of any chosen study course

student_id

Student Id

fullname

All name parts separated by hyphens

email

Email

history

Object history, a list of messages

interface waeup.kofa.students.interfaces.IStudentNavigation[source]

Extends: waeup.kofa.browser.interfaces.IStudentNavigationBase

Interface needed for navigation and logging. This interface is implemented by all content classes in the students section.

student

Student object of context

writeLogMessage(view, message)

Add an INFO message to students.log.

interface waeup.kofa.students.interfaces.IStudentOnlinePayment[source]

Extends: waeup.kofa.payments.interfaces.IOnlinePayment

A student payment via payment gateways.

redeemTicket()

Either create an appropriate access code or trigger an action directly.

certificate

Certificate to determine the correct p_level value

doAfterStudentPaymentApproval()

Process student after payment was approved.

p_current

Current Session Payment

p_level

Payment Level

student
doAfterStudentPayment()

Process student after payment was made.

approveStudentPayment()

Approve payment and process student.

interface waeup.kofa.students.interfaces.IStudentPaymentsContainer[source]

Extends: waeup.kofa.payments.interfaces.IPaymentsContainer

A container for student payment objects.

certificate

Certificate to determine the correct p_level value

interface waeup.kofa.students.interfaces.IStudentPersonal[source]

Extends: waeup.kofa.interfaces.IKofaObject

Representation of student personal data.

personal_updated

Updated

perm_address

Permanent Address

interface waeup.kofa.students.interfaces.IStudentPersonalEdit[source]

Extends: waeup.kofa.students.interfaces.IStudentPersonal

Interface for editing personal data by students. Here we can repeat the fields from IStudentPersonal and set the required if necessary.

perm_address

Permanent Address

interface waeup.kofa.students.interfaces.IStudentPreviousPayment[source]

Extends: waeup.kofa.interfaces.IKofaObject

An interface for adding previous session payments.

p_level

Payment Level

p_category

Payment Category

p_session

Payment Session

interface waeup.kofa.students.interfaces.IStudentRequestPW[source]

Extends: waeup.kofa.students.interfaces.IStudent

Representation of a student for first-time password request. This interface is used when students use the requestpw page to login for the the first time.

email

Email Address

firstname

First Name

number

Registr. or Matric. Number

interface waeup.kofa.students.interfaces.IStudentStudyCourse[source]

Extends: waeup.kofa.interfaces.IKofaObject

Representation of student study course data.

entry_mode

Entry Mode

addStudentStudyLevel(cert, studylevel)

Add a study level object.

is_previous

True if the study course is the previous course of studies

previous_verdict

Previous Verdict

certificate

Certificate

current_session

Current Session

is_postgrad

True if student is postgraduate student

entry_session

Entry Session

getTranscriptData()

Get a sorted list of dicts with level and course ticket data. This method is used for transcripts.

next_session_allowed

True if the student can proceed to next session

is_current

True if the study course is the current course of studies

current_level

Current Level

current_verdict

Current Verdict

interface waeup.kofa.students.interfaces.IStudentStudyCourseTranscript[source]

Extends: waeup.kofa.interfaces.IKofaObject

An interface for student transcripts.

entry_mode

Entry Mode

entry_session

Entry Session

interface waeup.kofa.students.interfaces.IStudentStudyCourseTransfer[source]

Extends: waeup.kofa.students.interfaces.IStudentStudyCourse

An interface used for student transfers.

current_level

Current Level

entry_session

Entry Session

certificate

Certificate

interface waeup.kofa.students.interfaces.IStudentStudyLevel[source]

Extends: waeup.kofa.interfaces.IKofaObject

A representation of student study level data.

is_current_level

True if level is current level of the student

level_title

Level title from source

updateCourseTicket(ticket, course)

Updates a course ticket object and return code if ticket has been invalidated.

gpa_params_rectified

Corrected sessional GPA parameters

passed_params

Information about passed and failed courses

level_session

Session

gpa

Unrectified GPA

gpa_params

GPA parameters for this level.

addCertCourseTickets(cert)

Collect all certificate courses and create course tickets automatically.

certcode

The certificate code of the study course

addCourseTicket(ticket, course)

Add a course ticket object.

getSessionString

Session title from source

cumulative_params

Cumulative GPA and other cumulative parameters for this level

level_verdict

Verdict

level

Level

validation_date

Validation Date

total_credits

Total Credits

course_registration_forbidden

Return error message if course registration is forbidden

number_of_tickets

Number of tickets contained in this level

validated_by

Validated by

interface waeup.kofa.students.interfaces.IStudentTranscript[source]

Extends: waeup.kofa.interfaces.IKofaObject

Representation of student transcript data.

transcript_comment

Comment

interface waeup.kofa.students.interfaces.IStudentUpdateByMatricNo[source]

Extends: waeup.kofa.students.interfaces.IStudent

Representation of a student. Skip regular matric_number validation.

matric_number

Matriculation Number

interface waeup.kofa.students.interfaces.IStudentUpdateByRegNo[source]

Extends: waeup.kofa.students.interfaces.IStudent

Representation of a student. Skip regular reg_number validation.

reg_number

Registration Number

interface waeup.kofa.students.interfaces.IStudentVerdictUpdate[source]

Extends: waeup.kofa.interfaces.IKofaObject

A interface for verdict imports.

current_level

Current Level

current_session

Current Session

bypass_validation

Bypass validation

current_verdict

Current Verdict

validated_by

Validated by

interface waeup.kofa.students.interfaces.IStudentsContainer[source]

Extends: waeup.kofa.interfaces.IKofaObject

A students container contains university students.

addStudent(student)

Add an IStudent object and subcontainers.

unique_student_id

A unique student id

interface waeup.kofa.students.interfaces.IStudentsUtils[source]

A collection of methods which are subject to customization.

clearance_disabled_message(student)

Render message if clearance is disabled.

getDegreeClassNumber(level_obj)

Get degree class number (used for SessionResultsPresentation reports).

getAccommodation_details(student)

Determine the accommodation dates of a student.

setMatricNumber(student)

Set matriculation number of student.

If the student’s matric number is unset a new matric number is constructed according to the matriculation number construction rules defined in the constructMatricNumber method. The new matric number is set, the students catalog updated. The corresponding matric number counter is increased by one.

This method is tested but not used in the base package. It can be used in custom packages by adding respective views and by customizing increaseMatricInteger and constructMatricNumber according to the university’s matriculation number construction rules.

The method can be disabled by setting the counter to zero.

constructMatricNumber(student)

Fetch the matric number counter which fits the student and construct the new matric number of the student.

In the base package the counter is returned which is as an attribute of the site configuration object.

setReturningData(student)

This method defines what happens after school fee payment depending on the student’s senate verdict.

In the base configuration current level is always increased by 100 no matter which verdict has been assigned.

setPaymentDetails(category, student, previous_session=None, previous_level=None)

Create Payment object and set the payment data of a student for the payment category specified.

renderPDFCourseticketsOverview(view, session, data, lecturers)

Render pdf slip of course tickets for a lecturer.

renderPDF(view, subject='', filename='slip.pdf')

Render pdf slips for various pages.

renderPDFAdmissionLetter(view, student=None, omit_fields=(), pre_text=None, post_text=None)

Render pdf admission letter.

renderPDFTranscript(view, filename, student, studentview, note, signatures, sigs_in_footer, show_scans, topMargin, omit_fields, tableheader, no_passport)

Render pdf slip of a transcripts.

getPDFCreator(context)

Get some IPDFCreator instance suitable for use with context.

warnCreditsOOR(studylevel, course=None)

Return message if credits are out of range. In the base package only maximum credits is set.

increaseMatricInteger(student)

Increase counter for matric numbers.

This counter can be a centrally stored attribute or an attribute of faculties, departments or certificates. In the base package the counter is as an attribute of the site configuration object.

selectBed(available_beds)

Select a bed from a list of available beds. In the standard configuration we select the first bed found, but can also randomize the selection if we like.

getBedCoordinates(bedticket)

Return descriptive bed coordinates. This method can be used to customize the display_coordinates property method in order to display a customary description of the bed space.

interface waeup.kofa.students.interfaces.IUGStudentClearance[source]

Extends: waeup.kofa.interfaces.IKofaObject

Representation of undergraduate student clearance data.

officer_comment

Officer’s Comment

date_of_birth

Date of Birth

clr_code

CLR Activation Code

nationality

Nationality

class waeup.kofa.students.interfaces.PreviousPaymentCategorySource[source]

Bases: waeup.kofa.interfaces.ContextualDictSourceFactoryBase

A source that delivers all selectable categories of previous session payments.

DICT_NAME = 'PREVIOUS_PAYMENT_CATEGORIES'

name of dict to deliver from kofa utils.

__doc__ = 'A source that delivers all selectable categories of previous session\n payments.\n '
__module__ = 'waeup.kofa.students.interfaces'
class waeup.kofa.students.interfaces.VerdictSource[source]

Bases: zc.sourcefactory.contextual.BasicContextualSourceFactory

A verdicts source delivers all verdicts provided in the portal.

__doc__ = 'A verdicts source delivers all verdicts provided\n in the portal.\n '
__module__ = 'waeup.kofa.students.interfaces'
getTitle(context, value)[source]
getToken(context, value)[source]
getValues(context)[source]