Package example.app.entities.compartments

Class Batch

java.lang.Object

example.app.entities.compartments.Batch

All Implemented Interfaces:

FileDatabaseCompatible, Serializable

public class Batch
extends Object
implements Serializable, FileDatabaseCompatible

Class Batch

This class represent a batch.

• Id: UUID v4 that is immutable after assignment
• Name: Name of the batch
• Description: Description of the batch (optional)
• Start Date and End Date: Start date and end date of the batch. Start date always needs to come before the end date
• Duration: Duration of the batch in days. Duration have to be greater than zero
• Course: Course that has been assigned to the batch
• Creation Date: Date and time on which the batch was created. It's immutable
• Assigned Faculties: A list of faculties that has been assigned to the batch
• For two batches to be same, only name, start and end date, course needs to be equal

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Batch(String name, Course course, String description, String startDate, String endDate)
Batch(String name, Course course, String description, LocalDateTime startDate, LocalDateTime endDate)

Method Summary

Modifier and Type	Method	Description
void	addFaculties(Faculty... faculties)	This method assigns an array of faculties to the batch
boolean	equals(Object o)
TreeMap<LocalDateTime,UUID>	getAssignedFaculties()
Course	getCourse()	Getter for the course of the batch
LocalDateTime	getCreationDate()	Getter for the batch creation date
String	getDescription()	Getter for the description of the batch
long	getDurationDays()	Getter for the duration of the batch
LocalDateTime	getEndDate()	Getter for the end date of the batch
UUID	getId()	Getter for the id of the batch
String	getName()	Getter for the name of the batch
LocalDateTime	getStartDate()	Getter for the start date of the batch
int	hashCode()
void	removeFaculties(Faculty... faculties)	This method removes an array of faculties from the batch
void	setCourse(Course course)	Setter for the course of the batch
void	setDate(String startDate, long durationDays)	Setter for the start and duration of the batch
void	setDate(String startDate, String endDate)	Setter for the start and end date of the batch
void	setDate(LocalDateTime startDate, long durationDays)	Setter for the start and duration of the batch
void	setDate(LocalDateTime startDate, LocalDateTime endDate)	Setter for the start and end date of the batch
void	setDescription(String description)	Setter for the description of the batch.
void	setDurationDays(long durationDays)	Setter for the duration of the batch
void	setEndDate(String endDate)	Setter for the end date of the batch
void	setEndDate(LocalDateTime endDate)	Setter for the end date of the batch
void	setName(String name)	Setter for the name of the batch
void	setStartDate(String startDate)	Setter for the start date of the batch
void	setStartDate(LocalDateTime startDate)	Setter for the start date of the batch
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Batch

public Batch(String name,
 Course course,
 String description,
 String startDate,
 String endDate)
      throws NullArgumentException,
EmptyArgumentException,
InvalidDateException

Throws:

NullArgumentException

EmptyArgumentException

InvalidDateException

Batch

public Batch(String name,
 Course course,
 String description,
 LocalDateTime startDate,
 LocalDateTime endDate)
      throws NullArgumentException,
EmptyArgumentException,
InvalidDateException

Throws:

NullArgumentException

EmptyArgumentException

InvalidDateException

Method Details

getId

public UUID getId()

Getter for the id of the batch

Specified by:

getId in interface FileDatabaseCompatible

Returns:

the id of the batch

getName

public String getName()

Getter for the name of the batch

Returns:

the name of the batch

setName

public void setName(String name)
             throws NullArgumentException,
EmptyArgumentException

Setter for the name of the batch

Parameters:

name - the name of the batch

Throws:

NullArgumentException - if the name is null

EmptyArgumentException - if the name is empty

getCourse

public Course getCourse()

Getter for the course of the batch

Returns:

the course of the batch

setCourse

public void setCourse(Course course)
               throws NullArgumentException

Setter for the course of the batch

Parameters:

course - a course that needs to added to the batch

Throws:

NullArgumentException - if the course is null

getDescription

public String getDescription()

Getter for the description of the batch

Returns:

the description of the batch

setDescription

public void setDescription(String description)
                    throws NullArgumentException

Setter for the description of the batch. Description can be an empty string as it's optional

Parameters:

description - the description of the batch

Throws:

NullArgumentException - if the description is null

setDate

public void setDate(LocalDateTime startDate,
 LocalDateTime endDate)
             throws NullArgumentException,
InvalidDateException

Setter for the start and end date of the batch

Parameters:

startDate - the start date of the batch

endDate - the end date of the batch

Throws:

NullArgumentException - if the startDate or endDate is null

InvalidDateException - if the startDate is after or equal to the endDate

setDate

public void setDate(String startDate,
 String endDate)
             throws InvalidDateException,
NullArgumentException

Setter for the start and end date of the batch

Parameters:

startDate - the start date of the batch

endDate - the end date of the batch

Throws:

NullArgumentException - if the startDate or endDate is null

InvalidDateException - if the startDate or endDate in wrong format or if the startDate is after or equal to the endDate

setDate

public void setDate(LocalDateTime startDate,
 long durationDays)
             throws NullArgumentException,
InvalidDateException

Setter for the start and duration of the batch

Parameters:

startDate - the start date of the batch

durationDays - the duration of the batch

Throws:

NullArgumentException - if the startDate is null

InvalidDateException - if the durationDays is negative or zero

setDate

public void setDate(String startDate,
 long durationDays)
             throws NullArgumentException,
InvalidDateException

Setter for the start and duration of the batch

Parameters:

startDate - the start date of the batch

durationDays - the duration of the batch

Throws:

NullArgumentException - if the startDate is null

InvalidDateException - if the startDate is in wrong format or if the durationDays is negative or zero

getStartDate

public LocalDateTime getStartDate()

Getter for the start date of the batch

Returns:

the start date of the batch

setStartDate

public void setStartDate(LocalDateTime startDate)
                  throws InvalidDateException,
NullArgumentException

Setter for the start date of the batch

Parameters:

startDate - the start date of the batch

Throws:

InvalidDateException - if the startDate is after the endDate

NullArgumentException - if the startDate is null

setStartDate

public void setStartDate(String startDate)
                  throws InvalidDateException,
NullArgumentException

Setter for the start date of the batch

Parameters:

startDate - the start date of the batch

Throws:

InvalidDateException - if the startDate is in wrong format or if it is after the or equal to the endDate

NullArgumentException - if the startDate is null

getEndDate

public LocalDateTime getEndDate()

Getter for the end date of the batch

Returns:

the end date of the batch

setEndDate

public void setEndDate(LocalDateTime endDate)
                throws InvalidDateException,
NullArgumentException

Setter for the end date of the batch

Parameters:

endDate - the end date of the batch

Throws:

InvalidDateException - if the endDate is before or equal to the startDate

NullArgumentException - if the endDate is null

setEndDate

public void setEndDate(String endDate)
                throws InvalidDateException,
NullArgumentException

Setter for the end date of the batch

Parameters:

endDate - the end date of the batch

Throws:

InvalidDateException - if the endDate is before or equal to the startDate or if the endDate is in wrong format

NullArgumentException - if the endDate is null

getDurationDays

public long getDurationDays()

Getter for the duration of the batch

Returns:

the duration of the batch

setDurationDays

public void setDurationDays(long durationDays)
                     throws InvalidDateException,
NullArgumentException

Setter for the duration of the batch

Parameters:

durationDays - the duration of the batch

Throws:

InvalidDateException - if the durationDays is negative or zero

NullArgumentException - if the durationDays is null

getAssignedFaculties

public TreeMap<LocalDateTime,UUID> getAssignedFaculties()

Returns:

A list of the assigned faculties

addFaculties

public void addFaculties(Faculty... faculties)
                  throws NullArgumentException,
DuplicatePresentException,
CannotCreateFileException,
FileDatabaseConfigFileException,
FileDatabaseInternalException,
IOException,
ClassNotFoundException

This method assigns an array of faculties to the batch

Parameters:

faculties - the faculties to add to the batch

Throws:

NullArgumentException - if any given faculty is null and in that case does not add any faculty to the batch

DuplicatePresentException

CannotCreateFileException

FileDatabaseConfigFileException

FileDatabaseInternalException

IOException

ClassNotFoundException

removeFaculties

public void removeFaculties(Faculty... faculties)

This method removes an array of faculties from the batch

Parameters:

faculties - the faculties to remove from the batch

getCreationDate

public LocalDateTime getCreationDate()

Getter for the batch creation date

Specified by:

getCreationDate in interface FileDatabaseCompatible

Returns:

the batch creation date

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