Package example.app.entities.compartments

Class Faculty

java.lang.Object

example.app.entities.compartments.Faculty

All Implemented Interfaces:

FileDatabaseCompatible, Serializable

public class Faculty
extends Object
implements Serializable, FileDatabaseCompatible

Class Faculty

This class represents a faculty and its attributes.

• Id: UUID v4 that is immutable after assignment
• Code: code of the faculty
• Description: description of the faculty (optional)
• Faculty User: Faculty user who is assigned to this faculty
• Faculty Creation Date: Date and time on which the faculty was created. It's immutable
• Assigned Batches: A list of batches that has been assigned to the faculty
• For two faculty to be same, only code needs to be equal

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Faculty(String code, String description, FacultyUser facultyUser)

Method Summary

Modifier and Type	Method	Description
void	addBatches(Batch... batches)	/** This method adds a list of batches to the faculty
boolean	equals(Object o)
TreeMap<LocalDateTime,UUID>	getAssignedBatches()	Getter for assigned batches
String	getCode()	Getter for faculty code
LocalDateTime	getCreationDate()	Getter for faculty creation date
String	getDescription()	Getter for faculty description
FacultyUser	getFacultyUser()	Getter for faculty user
UUID	getId()	Getter for faculty id
int	hashCode()
void	removeBatches(Batch... batches)	This method removes a list of batches from the faculty
void	setCode(String code)	Setter of the faculty code
void	setDescription(String description)	Setter of the faculty description.
void	setFacultyUser(FacultyUser facultyUser)	Setter of the faculty user
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Faculty

public Faculty(String code,
 String description,
 FacultyUser facultyUser)
        throws NullArgumentException,
EmptyArgumentException

Throws:

NullArgumentException

EmptyArgumentException

Method Details

getId

public UUID getId()

Getter for faculty id

Specified by:

getId in interface FileDatabaseCompatible

Returns:

UUID v4

getCode

public String getCode()

Getter for faculty code

Returns:

code of the faculty

setCode

public void setCode(String code)
             throws NullArgumentException,
EmptyArgumentException

Setter of the faculty code

Parameters:

code - code of the faculty

Throws:

NullArgumentException - if code is null

EmptyArgumentException - if code is empty

getDescription

public String getDescription()

Getter for faculty description

Returns:

description of the faculty

setDescription

public void setDescription(String description)
                    throws NullArgumentException

Setter of the faculty description. It can be an empty string as it's optional

Parameters:

description - description of the faculty

Throws:

NullArgumentException - if description is null

getFacultyUser

public FacultyUser getFacultyUser()

Getter for faculty user

Returns:

Faculty user

setFacultyUser

public void setFacultyUser(FacultyUser facultyUser)
                    throws NullArgumentException

Setter of the faculty user

Parameters:

facultyUser - Faculty user to be set

Throws:

NullArgumentException - if facultyUser is null

getCreationDate

public LocalDateTime getCreationDate()

Getter for faculty creation date

Specified by:

getCreationDate in interface FileDatabaseCompatible

Returns:

date and time on which the faculty was created

getAssignedBatches

public TreeMap<LocalDateTime,UUID> getAssignedBatches()

Getter for assigned batches

Returns:

TreeMap of assigned batches

addBatches

public void addBatches(Batch... batches)
                throws NullArgumentException,
DuplicatePresentException,
CannotCreateFileException,
FileDatabaseConfigFileException,
FileDatabaseInternalException,
IOException,
ClassNotFoundException

/** This method adds a list of batches to the faculty

Parameters:

batches - list of batches

Throws:

NullArgumentException - if any of the batch is null. In that case it does not add the batches

DuplicatePresentException

CannotCreateFileException

FileDatabaseConfigFileException

FileDatabaseInternalException

IOException

ClassNotFoundException

removeBatches

public void removeBatches(Batch... batches)

This method removes a list of batches from the faculty

Parameters:

batches - list of batches to be removed

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object