Class BookRoomDTO

java.lang.Object

de.gustavblass.fsu.fmi.roombooking.dto.FilterReservationsDTO

de.gustavblass.fsu.fmi.roombooking.dto.BookRoomDTO

public class BookRoomDTO
extends FilterReservationsDTO

Data-transfer object that represents a new Reservation that shall be placed.

Field Summary

Fields

Modifier and Type	Field	Description
private @Nullable Boolean	accessibility	If set, indicates whether the user needs an accessible Room.
private @Nullable Map<String, IndividualEquipmentMutableDTO>	cachedIndividualEquipmentMap	Remembers the return value of getIndividualEquipmentMap() until the individualEquipment is updated.
private @Nullable @Unmodifiable Set<String>	commonEquipment	The ConferenceRoom.commonEquipment.
private @NonNull List<IndividualEquipmentMutableDTO>	individualEquipment	The Room.equipment.
private @Nullable Integer	seats	The SeatReservation.count.
private @Nullable @NotNull ReservationType	type	Whether this DTO represents a regular Reservation or a SeatReservation.
private @Nullable @NotNull String	use	The Reservation.intendedUse.

Constructor Summary

Constructors

Constructor	Description
BookRoomDTO()

Method Summary

Modifier and Type	Method	Description
@NonNull Optional<Boolean>	accessibility()
@Nullable Boolean	getAccessibility()	Warning! Do not use this method! It is meant for the Spring framework only.
@NonNull Set<String>	getCommonEquipment()
@NonNull List<IndividualEquipmentMutableDTO>	getIndividualEquipment()
@NonNull @Unmodifiable Map<String, IndividualEquipmentMutableDTO>	getIndividualEquipmentMap()
@Nullable Integer	getSeats()	Warning! Do not use this method! It is meant for the Spring framework only.
@Nullable ReservationType	getType()	Warning! Do not use this method! It is meant for the Spring framework only.
@Nullable String	getUse()	Warning! Do not use this method! It is meant for the Spring framework only.
boolean	hasIndividualEquipment()
@NonNull Optional<String>	intendedUse()
@NonNull Optional<Integer>	seats()
void	setCommonEquipment(@NonNull Collection<String> commonEquipment)	Updates the commonEquipment.
void	setIndividualEquipment(Collection<IndividualEquipmentMutableDTO> individualEquipment)	Updates the individualEquipment.
void	setUse(@Nullable String intendedUse)	Updates the intended use.
@NonNull Optional<ReservationType>	type()

Methods inherited from class FilterReservationsDTO

date, from, getDate, getFrom, getRoom, getTo, isEmpty, onlyRoomIsSet, roomNumber, setDate, setFrom, setRoom, setTo, to

Methods inherited from class Object

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

Field Details

use

@Nullable
@NotNull
private @Nullable @NotNull String use

The Reservation.intendedUse.

type

@Nullable
@NotNull
private @Nullable @NotNull ReservationType type

Whether this DTO represents a regular Reservation or a SeatReservation.

seats

@Nullable
private @Nullable Integer seats

The SeatReservation.count. If set, this BookRoomDTO does not necessarily represent a SeatReservation. This seat count must only be taken into account if the type is ReservationType.SEAT_RESERVATION. Otherwise, this seat count must be ignored.

individualEquipment

@NonNull
private @NonNull List<IndividualEquipmentMutableDTO> individualEquipment

The Room.equipment.

commonEquipment

@Nullable
private @Nullable @Unmodifiable Set<String> commonEquipment

The ConferenceRoom.commonEquipment. Must only be set if the type is RoomType.CONFERENCE_ROOM.

accessibility

@Nullable
private @Nullable Boolean accessibility

If set, indicates whether the user needs an accessible Room.

cachedIndividualEquipmentMap

@Nullable
private @Nullable Map<String, IndividualEquipmentMutableDTO> cachedIndividualEquipmentMap

Remembers the return value of getIndividualEquipmentMap() until the individualEquipment is updated.

Constructor Details

BookRoomDTO

public BookRoomDTO()

Method Details

setUse

public void setUse(@Nullable
 @Nullable String intendedUse)

Updates the intended use.

Parameters:

intendedUse - The new intended use Will not be set if it is blank.

getUse

@Nullable
public @Nullable String getUse()

Warning! Do not use this method! It is meant for the Spring framework only.

See Also:

• intendedUse()

getType

@Nullable
public @Nullable ReservationType getType()

Warning! Do not use this method! It is meant for the Spring framework only.

See Also:

• type()

getSeats

@Nullable
public @Nullable Integer getSeats()

Warning! Do not use this method! It is meant for the Spring framework only.

See Also:

• seats()

getAccessibility

@Nullable
public @Nullable Boolean getAccessibility()

Warning! Do not use this method! It is meant for the Spring framework only.

See Also:

• accessibility()

intendedUse

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

Returns:

The intended use, if specified.

type

@NonNull
public @NonNull Optional<ReservationType> type()

Returns:

The type, if specified.

seats

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

Returns:

The seat count, if specified.

accessibility

@NonNull
public @NonNull Optional<Boolean> accessibility()

Returns:

Whether the Room shall be accessible, if specified.

getIndividualEquipment

@NonNull
public @NonNull List<IndividualEquipmentMutableDTO> getIndividualEquipment()

Returns:

The individualEquipment.

Implementation Note:

Spring uses the reference of the individualEquipment list to fill in the actual form inputs. To the author's current knowledge, there is no alternative to this violation of good programming practices.

getIndividualEquipmentMap

@NonNull
public @NonNull @Unmodifiable Map<String, IndividualEquipmentMutableDTO> getIndividualEquipmentMap()

Returns:

The individualEquipment as a Map where the IndividualEquipmentMutableDTO.type serves as the key and the DTO itself as the value.

Implementation Note:

Returns the cachedIndividualEquipmentMap if not null.

getCommonEquipment

@Contract(pure=true)
@NonNull
public @NonNull Set<String> getCommonEquipment()

Returns:

The commonEquipment. Empty if no common equipment is defined.

hasIndividualEquipment

@Contract(pure=true)
public boolean hasIndividualEquipment()

Returns:

True if there is at least one item in the individualEquipment with IndividualEquipmentMutableDTO.count > 0. False otherwise.

setIndividualEquipment

public void setIndividualEquipment(Collection<IndividualEquipmentMutableDTO> individualEquipment)
                            throws de.gustavblass.commons.exceptions.IllegalArgumentException

Updates the individualEquipment.

Parameters:

individualEquipment - The new individualEquipment. No IndividualEquipmentType must occur more than once.

Throws:

de.gustavblass.commons.exceptions.IllegalArgumentException - If one of the individual-equipment types occurs more than once.

Implementation Note:

Clears the cachedIndividualEquipmentMap.

setCommonEquipment

public void setCommonEquipment(@NonNull
 @NonNull Collection<String> commonEquipment)
                        throws de.gustavblass.commons.exceptions.IllegalArgumentException

Updates the commonEquipment.

Parameters:

commonEquipment - The new common equipment. No CommonEquipmentType must occur more than once.

Throws:

de.gustavblass.commons.exceptions.IllegalArgumentException - If one of the common-equipment types occurs more than once.