Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.grades

Class Exam

java.lang.Object

page.codeberg.friedolyn.grades.Exam

All Implemented Interfaces:

Copyable<Exam>, Redactable

public class Exam
extends Object
implements Redactable, Copyable<Exam>

Represents a single exam of a Module in the grades table.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Exam.ExamStatus	Whether the exam is over and, if so, whether successful or not.

Field Summary

Fields

Modifier and Type	Field	Description
private LocalDate	accountingDate	The date on which the exam was added to the student's grades table in the Friedolin system.
private Integer	attempt	Which time the student took the exam, starting with 1 for the first attempt.
private LocalDate	examDate	The date on which the exam took place.
private String	examiner	The name of the professor who conducted the exam, graded it or was responsible for the accounting.
private String	examNumber	The “Prüfungsnummer” (exam number) assigned to the exam, without the label P-Nr.:.
private String	examTitle	The human-readable name of the exam, e.g.
private Grade	grade	The student's grade in the exam, between 0.7 and 5.0.
private Semester	semester	The semester in which the exam took place.
private Exam.ExamStatus	status	Whether the exam is over and, if so, whether successful or not.

Constructor Summary

Constructors

Constructor	Description
Exam()

Method Summary

Modifier and Type	Method	Description
@NonNull Changes<Exam>	computeDifference(@NonNull Exam other)	Checks which fields of this Exam differ from the given Exam.
@NonNull Exam	copy()
boolean	equals(Object object)	Compares this Exam with the given object.
@NonNull Optional<LocalDate>	getAccountingDate()
@NonNull Optional<Integer>	getAttempt()
@NonNull Optional<LocalDate>	getExamDate()
@NonNull Optional<String>	getExaminer()
@NonNull Optional<String>	getExamNumber()
@NonNull Optional<String>	getExamTitle()
@NonNull Optional<Grade>	getGrade()
@NonNull Optional<Semester>	getSemester()
@NonNull Optional<Exam.ExamStatus>	getStatus()
void	setAccountingDate(@NonNull LocalDate accountingDate)	Updates the accountingDate to the given value.
void	setAttempt(int attempt)	Updates the attempt to the given value.
void	setExamDate(@NonNull LocalDate examDate)	Updates the examDate to the given value.
void	setExaminer(@NonNull String examiner)	Updates the examiner to the given value.
void	setExamNumber(@NonNull String examNumber)	Updates the examNumber to the given value.
void	setExamTitle(@NonNull String examTitle)	Updates the human-readable name of the exam to the given value.
void	setGrade(@NonNull Grade grade)	Updates the grade to the given value.
void	setSemester(@NonNull Semester semester)	Updates the semester to the given value.
void	setStatus(@NonNull Exam.ExamStatus status)	Updates the status to the given value.
@NonNull String	toString()
@NonNull String	toStringRedacted()

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

examNumber

@Nullable
private String examNumber

The “Prüfungsnummer” (exam number) assigned to the exam, without the label P-Nr.:.

examTitle

@Nullable
private String examTitle

The human-readable name of the exam, e.g. Fortgeschrittenes Programmierpraktikum: Projekt or Systemsoftware: Klausur oder mündliche Prüfung.

semester

@Nullable
private Semester semester

The semester in which the exam took place.

grade

@Nullable
private Grade grade

The student's grade in the exam, between 0.7 and 5.0. May be missing if the student did not participate in the exam due to illness:`RAT (“Rücktritt mit Attest”), meaning “withdrawal with medical certificate”.

Missing grade:

status

@Nullable
private Exam.ExamStatus status

Whether the exam is over and, if so, whether successful or not.

attempt

@Nullable
private Integer attempt

Which time the student took the exam, starting with 1 for the first attempt.

examDate

@Nullable
private LocalDate examDate

The date on which the exam took place. May be missing for unknown reasons.

Missing exam date:

examiner

@Nullable
private String examiner

The name of the professor who conducted the exam, graded it or was responsible for the accounting. Which role the examiner had is not specified by the Friedolin system. May be missing for unknown reasons.

Missing examiner:

accountingDate

@Nullable
private LocalDate accountingDate

The date on which the exam was added to the student's grades table in the Friedolin system.

Constructor Details

Exam

public Exam()

Method Details

getExamNumber

@NonNull
public @NonNull Optional<String> getExamNumber()

Returns:

The examNumber, if present. Empty otherwise.

getExamTitle

@NonNull
public @NonNull Optional<String> getExamTitle()

Returns:

The examTitle, if present. Empty otherwise.

getSemester

@NonNull
public @NonNull Optional<Semester> getSemester()

Returns:

The semester, if present. Empty otherwise.

getGrade

@NonNull
public @NonNull Optional<Grade> getGrade()

Returns:

The grade, if present. Empty otherwise.

getStatus

@NonNull
public @NonNull Optional<Exam.ExamStatus> getStatus()

Returns:

The status, if present. Empty otherwise.

getAttempt

@NonNull
public @NonNull Optional<Integer> getAttempt()

Returns:

The attempt, if present. Empty otherwise.

getExamDate

@NonNull
public @NonNull Optional<LocalDate> getExamDate()

Returns:

The examDate, if present. Empty otherwise.

getExaminer

@NonNull
public @NonNull Optional<String> getExaminer()

Returns:

The examiner, if present. Empty otherwise.

getAccountingDate

@NonNull
public @NonNull Optional<LocalDate> getAccountingDate()

Returns:

The accountingDate, if present. Empty otherwise.

setExamNumber

public void setExamNumber(@NonNull
 @NonNull String examNumber)
                   throws IllegalArgumentException

Updates the examNumber to the given value. Strips the label P-Nr.: from the value, if present.

Parameters:

examNumber - The new exam number. Expected (but not enforced) to be in the format P-Nr.: 123456. Must not be blank.

Throws:

IllegalArgumentException - If the exam number is blank.

setExamTitle

public void setExamTitle(@NonNull
 @NonNull String examTitle)
                  throws IllegalArgumentException

Updates the human-readable name of the exam to the given value.

Parameters:

examTitle - The new exam's name. Must not be blank.

Throws:

IllegalArgumentException - If the exam title is blank.

setSemester

public void setSemester(@NonNull
 @NonNull Semester semester)

Updates the semester to the given value.

Parameters:

semester - The semester in which the exam took place. Must not be blank.

setGrade

public void setGrade(@NonNull
 @NonNull Grade grade)

Updates the grade to the given value.

Parameters:

grade - The new grade in the exam.

setStatus

public void setStatus(@NonNull
 @NonNull Exam.ExamStatus status)

Updates the status to the given value.

Parameters:

status - Whether the exam is over and, if so, whether successful or not. Must not be blank.

setAttempt

public void setAttempt(int attempt)
                throws IllegalArgumentException

Updates the attempt to the given value.

Parameters:

attempt - Which time the student took the exam, starting with 1 for the first attempt. Must be greater than 0.

Throws:

IllegalArgumentException - If the attempt number is less than 1.

setExamDate

public void setExamDate(@NonNull
 @NonNull LocalDate examDate)
                 throws IllegalArgumentException

Updates the examDate to the given value.

Parameters:

examDate - The date on which the exam took place. Must be after 1990-10-03 and before today + 1 year.

Throws:

IllegalArgumentException - If the exam date is before 1990-10-03 or after today + 1 year.

setExaminer

public void setExaminer(@NonNull
 @NonNull String examiner)
                 throws IllegalArgumentException

Updates the examiner to the given value.

Parameters:

examiner - The name of the professor who conducted the exam, graded it or was responsible for the accounting. Must not be blank.

Throws:

IllegalArgumentException - If the examiner's name is blank.

setAccountingDate

public void setAccountingDate(@NonNull
 @NonNull LocalDate accountingDate)
                       throws IllegalArgumentException

Updates the accountingDate to the given value.

Parameters:

accountingDate - The date on which the exam was added to the student's grades table in the Friedolin system. Must be after 1990-10-03 and before today + 1 year.

Throws:

IllegalArgumentException - If the accounting date is before 1990-10-03 or after today + 1 year.

equals

public boolean equals(Object object)

Compares this Exam with the given object.

Overrides:

equals in class Object

Parameters:

object - The object to compare this Exam with.

Returns:

• true if the given object is an Exam whose fields' values match their equivalents in this Exam, especially (but not exclusively) if the given Exam is the exact same reference as this Exam.
• false if the given object is not an Exam or if any of the fields' values differ from their equivalents in this Exam.

computeDifference

@NonNull
public @NonNull Changes<Exam> computeDifference(@NonNull
 @NonNull Exam other)

Checks which fields of this Exam differ from the given Exam.

Parameters:

other - A different Exam reference to compare this Exam with.

Returns:

• Changes.oldVersion(): A new Exam with the values of those fields of this Exam that differ from their equivalents in the given Exam.
• Changes.newVersion(): A new Exam with the values of those fields of the given Exam that differ from their equivalents in this Exam.
• Changes.unchanged(): A new Exam with the values of those fields that are the same in both Exams.

copy

@NonNull
public @NonNull Exam copy()

Specified by:

copy in interface Copyable<Exam>

Returns:

A new Exam reference whose fields have the exact same values as this Exam.

toString

@NonNull
public @NonNull String toString()

Specified by:

toString in interface Redactable

Overrides:

toString in class Object

Returns:

A string representation of this Exam.

toStringRedacted

@NonNull
public @NonNull String toStringRedacted()

Specified by:

toStringRedacted in interface Redactable

Returns:

A redacted string representation of this Exam.