Package de.xima.fc.entities

Class AAppointmentClosingTime

java.lang.Object

de.xima.cmn.dao.model.AEntity<Long>

de.xima.fc.entities.AbstractEntity

de.xima.fc.entities.AbstractLockableEntity

de.xima.fc.entities.AAppointmentClosingTime

All Implemented Interfaces:

de.xima.cmn.dao.interfaces.IEntity<Long>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, IAppointmentClosingTime, ILockingVersionProviding, INameProviding, ITransferable, ITransferableEntity, ITransferableLockableEntity, IUUIDEntity, Serializable, Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>

Direct Known Subclasses:

AppointmentClientClosingTime, AppointmentClosingTime

@MappedSuperclass
@NotNullIf(field="timeFrom",dependants="allDay",test="isTimeRangeRequired") @NotNullIf(field="timeUntil",dependants="allDay",test="isTimeRangeRequired")
@SpanningRange(fieldStart="dateFrom",fieldEnd="dateUntil") @SpanningRange(fieldStart="timeFrom",fieldEnd="timeUntil")
public abstract class AAppointmentClosingTime
extends AbstractLockableEntity
implements IAppointmentClosingTime

Describes the closing hours of an AppointmentTemplate.

Since:

7.3.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields inherited from class de.xima.fc.entities.AbstractLockableEntity

COL_LOCKINGVERSION, lockingVersion

Fields inherited from class de.xima.fc.entities.AbstractEntity

COL_ID, id

Fields inherited from interface de.xima.fc.entities.interfaces.IAppointmentClosingTime

ATTR_ALL_DAY, ATTR_DATE_FROM, ATTR_DATE_UNTIL, ATTR_TIME_FROM, ATTR_TIME_UNTIL, COL_ALL_DAY, COL_DATE_FROM, COL_DATE_UNTIL, COL_TIME_FROM, COL_TIME_UNTIL

Fields inherited from interface de.xima.cmn.dao.interfaces.IEntity

ATTR_ID

Fields inherited from interface de.xima.cmn.dao.interfaces.ILockableEntity

ATTR_LOCKINGVERSION

Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding

ATTR_NAME, COL_NAME

Fields inherited from interface de.xima.fc.entities.interfaces.ITransferableEntity

IMPORT_ID, INVALID_ID

Fields inherited from interface de.xima.fc.entities.interfaces.IUUIDEntity

ATTR_UUID, COL_UUID, INVALID_UUID, INVALID_UUID_OBJECT, NULL_SAFE_UUID_TYPE, NULLABLE_UUID_TYPE, TYPE_NAME_UUID

Constructor Summary

Constructors

Constructor	Description
AAppointmentClosingTime()

Method Summary

Modifier and Type	Method	Description
protected void	cloneBasics(AAppointmentClosingTime copy)
LocalDate	getDateFrom()
LocalDate	getDateUntil()
Long	getId()
String	getName()
LocalTime	getTimeFrom()
LocalTime	getTimeUntil()
String	getUUID()	Gets the UUID (universal unique identifier) that uniquely identifies this type of entity.
UUID	getUUIDObject()	Gets the UUID (universal unique identifier) that uniquely identifies this type of entity.
boolean	isAllDay()
protected static boolean	isTimeRangeRequired(boolean allDay)
void	setAllDay(boolean allDay)
void	setDateFrom(LocalDate dateFrom)
void	setDateUntil(LocalDate dateUntil)
void	setName(String name)
void	setTimeFrom(LocalTime timeFrom)
void	setTimeUntil(LocalTime timeUntil)
void	setUUID(String uuid)	Sets the UUID (universal unique identifier) that uniquely identifies this type of entity.
void	setUUIDObject(UUID uuid)

Methods inherited from class de.xima.fc.entities.AbstractLockableEntity

entityHasChanged, getLockingVersion, setLockingVersion, toString

Methods inherited from class de.xima.fc.entities.AbstractEntity

asIntValue, isPersisted, setId, setId

Methods inherited from class de.xima.cmn.dao.model.AEntity

compareTo, equals, getDBTableName, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface de.xima.fc.entities.interfaces.IAppointmentClosingTime

getDate

Methods inherited from interface de.xima.cmn.dao.interfaces.IEntity

isPersisted, setId

Constructor Detail

AAppointmentClosingTime

public AAppointmentClosingTime()

Method Detail

getId

public Long getId()

Specified by:

getId in interface de.xima.cmn.dao.interfaces.IEntity<Long>

getDateFrom

public LocalDate getDateFrom()

Specified by:

getDateFrom in interface IAppointmentClosingTime

Returns:

The start date of this closing time. This is in the time zone defined by the corresponding AppointmentTemplate.getZoneId().

getDateUntil

public LocalDate getDateUntil()

Specified by:

getDateUntil in interface IAppointmentClosingTime

Returns:

The end dateof this closing time. This is in the time zone defined by the corresponding AppointmentTemplate.getZoneId().

getName

public String getName()

Specified by:

getName in interface INameProviding

Returns:

The name of this closing time, such as a holiday name (e.g. Easter or Christmas Eve).

getTimeFrom

public LocalTime getTimeFrom()

Specified by:

getTimeFrom in interface IAppointmentClosingTime

Returns:

The start time of this closing time. This is in the time zone defined by the corresponding AppointmentTemplate.getZoneId().

getTimeUntil

public LocalTime getTimeUntil()

Specified by:

getTimeUntil in interface IAppointmentClosingTime

Returns:

The end time of this closing time. This is in the time zone defined by the corresponding AppointmentTemplate.getZoneId().

isAllDay

public boolean isAllDay()

Specified by:

isAllDay in interface IAppointmentClosingTime

Returns:

Whether this closing time last the entire day. If so, getTimeFrom() and getTimeUntil() are ignored.

setAllDay

public void setAllDay(boolean allDay)

Specified by:

setAllDay in interface IAppointmentClosingTime

Parameters:

allDay - Whether this closing time last the entire day. If so, getTimeFrom() and getTimeUntil() are ignored.

setDateFrom

public void setDateFrom(LocalDate dateFrom)

Specified by:

setDateFrom in interface IAppointmentClosingTime

Parameters:

dateFrom - The start date of this closing time. This is in the time zone defined by the corresponding AppointmentTemplate.getZoneId().

setDateUntil

public void setDateUntil(LocalDate dateUntil)

Specified by:

setDateUntil in interface IAppointmentClosingTime

Parameters:

dateUntil - The end date of this closing time. This is in the time zone defined by the corresponding AppointmentTemplate.getZoneId().

setName

public void setName(String name)

Parameters:

name - The name of this closing time, such as a holiday name (e.g. Easter or Christmas Eve).

setTimeFrom

public void setTimeFrom(LocalTime timeFrom)

Specified by:

setTimeFrom in interface IAppointmentClosingTime

Parameters:

timeFrom - The start time of this closing time. This is in the time zone defined by the corresponding AppointmentTemplate.getZoneId().

setTimeUntil

public void setTimeUntil(LocalTime timeUntil)

Specified by:

setTimeUntil in interface IAppointmentClosingTime

Parameters:

timeUntil - The end time of this closing time. This is in the time zone defined by the corresponding AppointmentTemplate.getZoneId().

getUUID

public String getUUID()

Description copied from interface: IUUIDEntity

Gets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.

Specified by:

getUUID in interface IUUIDEntity

Returns:

The UUID of this closing time. Please note that this UUID is guaranteed to be unique only for a given client or AppointmentTemplate. That is, two appointment templates belonging to two different clients may have the same UUID.

getUUIDObject

public UUID getUUIDObject()

Description copied from interface: IUUIDEntity

Gets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.

Specified by:

getUUIDObject in interface IUUIDEntity

Returns:

The UUID of this closing time. Please note that this UUID is guaranteed to be unique only for a given client or AppointmentTemplate. That is, two appointment templates belonging to two different clients may have the same UUID.

setUUID

public void setUUID(String uuid)

Description copied from interface: IUUIDEntity

Sets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.

Specified by:

setUUID in interface IUUIDEntity

Parameters:

uuid - A new UUID for this closing time. Please note that this UUID is guaranteed to be unique only for a given client or AppointmentTemplate. That is, two appointment templates belonging to two different clients may have the same UUID.

setUUIDObject

public void setUUIDObject(UUID uuid)

Parameters:

uuid - A new UUID for this closing time. Please note that this UUID is guaranteed to be unique only for a given client or AppointmentTemplate. That is, two appointment templates belonging to two different clients may have the same UUID.

cloneBasics

protected void cloneBasics(AAppointmentClosingTime copy)

isTimeRangeRequired

protected static boolean isTimeRangeRequired(boolean allDay)