Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.grades

Class Subaccount

java.lang.Object

page.codeberg.friedolyn.grades.Subaccount

public class Subaccount
extends Object

A group of Modules that are part of an Account in the student's grades table.

Field Summary

Fields

Modifier and Type	Field	Description
private String	code	The unique identifier of the subaccount.
private ECTS	ects	The number of ECTS credits that the account's modules are worth in total.
private final @NonNull ArrayList<Module>	MODULES	The modules that are part of this account.
private Semester	semester	The meaning of this field is not clear, because the modules of this subaccount have not necessarily taken place in the same semester.
private String	title	The human-readable name of the account, e.g.

Constructor Summary

Constructors

Constructor	Description
Subaccount()

Method Summary

Modifier and Type	Method	Description
void	addModule(@NonNull Module module)	Adds a Module to the end of this subaccount's modules list.
void	addModules(@NonNull Module... modules)	Adds the specified Modules to the end of this subaccount's modules list.
void	clearModules()	Removes all modules from this subaccount's modules list.
boolean	equals(Object object)	Checks if the fields of this subaccount are equal to their counterparts in the given object (if it is a Subaccount at all).
@NonNull Optional<String>	getCode()
@NonNull Optional<ECTS>	getECTS()
@NonNull ArrayList<Module>	getModules()
@NonNull Optional<Semester>	getSemester()
@NonNull Optional<String>	getTitle()
@NonNull Module	removeModule(int index)	Removes the module at the specified position in this subaccount's modules list.
boolean	removeModule(@NonNull Module module)	Removes the first occurrence of the specified Module from this subaccount's modules list, if it is present.
@NonNull ArrayList<Module>	removeModules(int... indices)	Removes the modules at the specified positions in this subaccount's modules list.
boolean	removeModules(@NonNull Module... modules)	Removes the specified Modules from this subaccount's modules list, if they are present.
void	setCode(@NonNull String code)	Updates this subaccount's code to the given value.
void	setECTS(@NonNull ECTS ects)	Updates this subaccount's ects to the given value.
void	setTitle(@NonNull String title)	Updates this subaccount's title to the given value.
@NonNull String	toString()

Methods inherited from class java.lang.Object

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

Field Details

code

@Nullable
private String code

The unique identifier of the subaccount. Usually consists of the parent account's code letter and two or more letters, resulting in a string like A WP (“Konto A: Wahlpflichtmodule”) or B PF (“Konto B: Pflichtmodule”).

title

@Nullable
private String title

The human-readable name of the account, e.g. Konto A: Wahlpflichtmodule (meaning “Account A: Elective Compulsory Modules”).

semester

@Nullable
private Semester semester

The meaning of this field is not clear, because the modules of this subaccount have not necessarily taken place in the same semester. It is likely that this field represents the semester in which the most recent module of this subaccount took place, but this is not formally documented by the Friedolin system.

ects

@Nullable
private ECTS ects

The number of ECTS credits that the account's modules are worth in total.

MODULES

@NonNull
private final @NonNull ArrayList<Module> MODULES

The modules that are part of this account.

Constructor Details

Subaccount

public Subaccount()

Method Details

getCode

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

Returns:

The unique identifier of this subaccount. Usually consists of the parent account's code letter and two or more letters, resulting in a string like A WP (“Konto A: Wahlpflichtmodule”) or B PF (“Konto B: Pflichtmodule”).

getTitle

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

Returns:

The human-readable name of this subaccount, e.g. Konto A: Wahlpflichtmodule (meaning “Account A: Elective Compulsory Modules”).

getSemester

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

Returns:

The semester in which the most recent module of this subaccount took place. The meaning of this field is not clear, because the modules of this subaccount have not necessarily taken place in the same semester. It is likely that this field represents the semester in which the most recent module of this subaccount took place, but this is not formally documented by the Friedolin system.

getECTS

@NonNull
public @NonNull Optional<ECTS> getECTS()

Returns:

The number of ECTS credits that this subaccount's modules are worth in total.

getModules

@NonNull
public @NonNull ArrayList<Module> getModules()

Returns:

The modules that are part of this subaccount.

setCode

public void setCode(@NonNull
 @NonNull String code)
             throws IllegalArgumentException

Updates this subaccount's code to the given value.

Parameters:

code - The new subaccount code, which uniquely identifies the account among all accounts of the university. Must not be blank.

Throws:

IllegalArgumentException - If the given code is blank.

setTitle

public void setTitle(@NonNull
 @NonNull String title)
              throws IllegalArgumentException

Updates this subaccount's title to the given value.

Parameters:

title - The new account title, the human-readable name of the account. Must not be blank.

Throws:

IllegalArgumentException - If the given title is blank.

setECTS

public void setECTS(@NonNull
 @NonNull ECTS ects)

Updates this subaccount's ects to the given value.

Parameters:

ects - The new number of ECTS credits that the account's modules are worth in total.

addModule

public void addModule(@NonNull
 @NonNull Module module)

Adds a Module to the end of this subaccount's modules list.

Parameters:

module - The module to add.

addModules

public void addModules(@NonNull
 @NonNull Module... modules)

Adds the specified Modules to the end of this subaccount's modules list.

Parameters:

modules - The modules to add.

removeModule

public boolean removeModule(@NonNull
 @NonNull Module module)

Removes the first occurrence of the specified Module from this subaccount's modules list, if it is present.

Parameters:

module - The module to remove.

Returns:

true if this list contained the specified element, false otherwise.

removeModules

public boolean removeModules(@NonNull
 @NonNull Module... modules)

Removes the specified Modules from this subaccount's modules list, if they are present.

Parameters:

modules - The modules to remove.

Returns:

true if this list was modified as a result of this operation.

removeModule

@NonNull
public @NonNull Module removeModule(int index)
                             throws IndexOutOfBoundsException

Removes the module at the specified position in this subaccount's modules list.

Parameters:

index - The index of the module to remove. Must be between 0 (inclusive) and the size of the list (exclusive).

Returns:

The module previously at the specified position.

Throws:

IndexOutOfBoundsException - If the index is out of range.

removeModules

@NonNull
public @NonNull ArrayList<Module> removeModules(int... indices)
                                         throws IndexOutOfBoundsException

Removes the modules at the specified positions in this subaccount's modules list.

Parameters:

indices - The indices of the modules to remove. Must be between 0 (inclusive) and the size of the list (exclusive).

Returns:

The modules previously at the specified positions.

Throws:

IndexOutOfBoundsException - If any of the indices are out of range.

clearModules

public void clearModules()

Removes all modules from this subaccount's modules list.

equals

public boolean equals(Object object)

Checks if the fields of this subaccount are equal to their counterparts in the given object (if it is a Subaccount at all).

Overrides:

equals in class Object

Parameters:

object - The object to compare this subaccount with.

Returns:

true if the given object is a Subaccount and all fields are deeply equal, false otherwise.

toString

@NonNull
public @NonNull String toString()

Overrides:

toString in class Object

Returns:

A string representation of this subaccount, containing all fields and their values, as well as this subaccount's hash code.