Package de.xima.fc.entities
Class Appointment
- java.lang.Object
- 
- de.xima.cmn.dao.model.AEntity<Long>
- 
- de.xima.fc.entities.AbstractEntity
- 
- de.xima.fc.entities.AbstractLockableEntity
- 
- de.xima.fc.entities.Appointment
 
 
 
 
- 
- All Implemented Interfaces:
- de.xima.cmn.dao.interfaces.IEntity<Long>,- de.xima.cmn.dao.interfaces.ILockableEntity<Long>,- IEffectiveAppointmentStatusProviding,- ILockingVersionProviding,- IMandantDependent,- ITransferable,- ITransferableEntity,- ITransferableLockableEntity,- IUUIDEntity,- IVorgangDependent,- Serializable,- Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>
 
 @Entity public class Appointment extends AbstractLockableEntity implements IMandantDependent, IUUIDEntity, IVorgangDependent, IEffectiveAppointmentStatusProviding Describes a booked appointment. The available times are defined by theAppointmentTemplate.- Since:
- 6.5.0
- Author:
- XIMA MEDIA GmbH
- See Also:
- Serialized Form
 
- 
- 
Field SummaryFields Modifier and Type Field Description static StringATTR_APPOINTMENT_TYPEJPA attribute name for thegetAppointmentType()field.static StringATTR_STATUSJPA attribute name for thegetStatus()field.static StringATTR_TIMESTAMP_FROMJPA attribute name for thegetInstantFrom()field.static StringATTR_TIMESTAMP_UNTILJPA attribute name for thegetInstantUntil()field.protected @NotNull Mandantclient- 
Fields inherited from class de.xima.fc.entities.AbstractLockableEntityCOL_LOCKINGVERSION, lockingVersion
 - 
Fields inherited from class de.xima.fc.entities.AbstractEntityCOL_ID, id
 - 
Fields inherited from interface de.xima.fc.entities.interfaces.IMandantDependentATTR_MANDANT, COL_CLIENT_ID
 - 
Fields inherited from interface de.xima.fc.entities.interfaces.ITransferableEntityIMPORT_ID, INVALID_ID
 - 
Fields inherited from interface de.xima.fc.entities.interfaces.IUUIDEntityATTR_UUID, COL_UUID, INVALID_UUID, INVALID_UUID_OBJECT, NULL_SAFE_UUID_TYPE, TYPE_NAME_UUID
 - 
Fields inherited from interface de.xima.fc.entities.interfaces.IVorgangDependentATTR_VORGANG
 
- 
 - 
Constructor SummaryConstructors Constructor Description Appointment()
 - 
Method Summary- 
Methods inherited from class de.xima.fc.entities.AbstractLockableEntityentityHasChanged, getLockingVersion, setLockingVersion, toString
 - 
Methods inherited from class de.xima.fc.entities.AbstractEntityasIntValue, isPersisted, setId, setId
 - 
Methods inherited from class de.xima.cmn.dao.model.AEntitycompareTo, equals, getDBTableName, hashCode
 - 
Methods inherited from class java.lang.Objectclone, finalize, getClass, notify, notifyAll, wait, wait, wait
 - 
Methods inherited from interface java.lang.ComparablecompareTo
 - 
Methods inherited from interface de.xima.fc.entities.IEffectiveAppointmentStatusProvidinggetEffectiveStatus
 
- 
 
- 
- 
- 
Field Detail- 
ATTR_APPOINTMENT_TYPEpublic static final String ATTR_APPOINTMENT_TYPE JPA attribute name for thegetAppointmentType()field.- See Also:
- Constant Field Values
 
 - 
ATTR_STATUSpublic static final String ATTR_STATUS JPA attribute name for thegetStatus()field.- See Also:
- Constant Field Values
 
 - 
ATTR_TIMESTAMP_FROMpublic static final String ATTR_TIMESTAMP_FROM JPA attribute name for thegetInstantFrom()field.- See Also:
- Constant Field Values
 
 - 
ATTR_TIMESTAMP_UNTILpublic static final String ATTR_TIMESTAMP_UNTIL JPA attribute name for thegetInstantUntil()field.- See Also:
- Constant Field Values
 
 - 
client@NotNull protected @NotNull Mandant client 
 
- 
 - 
Method Detail- 
getAppointmentTypepublic AppointmentType getAppointmentType() - Returns:
- The appointment type for which this event was created.
 
 - 
getClientpublic Mandant getClient() - Returns:
- The client to which this event belongs.
 
 - 
getDateTimepublic com.google.common.collect.Range<LocalDateTime> getDateTime(ZoneId zoneId) - Parameters:
- zoneId- The time zone in which to return the result.
- Returns:
- The start and end date and time of this event, in the given time zone.
 
 - 
getDateTimeFrompublic LocalDateTime getDateTimeFrom(ZoneId zoneId) - Parameters:
- zoneId- The time zone in which to return the start time.
- Returns:
- The start date and time of this event, in the given time zone.
 
 - 
getDateTimeUntilpublic LocalDateTime getDateTimeUntil(ZoneId zoneId) - Parameters:
- zoneId- The time zone in which to return the end time.
- Returns:
- The end date and time of this event, in the given time zone.
 
 - 
getDurationpublic Duration getDuration() - Returns:
- The duration of this appointment.
 
 - 
getFormRecordpublic Vorgang getFormRecord() - Returns:
- The form record where this appointment was booked. This may be nullwhen the form record was deleted.
 
 - 
getInstantpublic com.google.common.collect.Range<Instant> getInstant() - Returns:
- The start and end point of this appointment.
 
 - 
getInstantFrompublic Instant getInstantFrom() - Returns:
- The start point of this appointment.
 
 - 
getInstantUntilpublic Instant getInstantUntil() - Returns:
- The end point of this appointment.
 
 - 
getMandant@Deprecated public Mandant getMandant() Deprecated.UsegetClient().- Specified by:
- getMandantin interface- IMandantDependent
- Returns:
- The client to which this event belongs.
 
 - 
getStatuspublic EAppointmentStatus getStatus() - Specified by:
- getStatusin interface- IEffectiveAppointmentStatusProviding
- Returns:
- The current status of this appointment, e.g. whether it is booked, canceled etc.
 
 - 
getTimestampFrompublic long getTimestampFrom() - Returns:
- The start point of this appointment as an epoch (unix timestamp) in milliseconds.
 
 - 
getTimestampUntilpublic long getTimestampUntil() - Returns:
- The end point of this appointment as an epoch (unix timestamp) in milliseconds.
 
 - 
getUUIDpublic String getUUID() - Specified by:
- getUUIDin interface- IUUIDEntity
- Returns:
- UUID (Universal Unique Identifier) that identifies this type of entity. Usually is unique within a context,
 e.g. Mandant,Projekt, ...
 
 - 
getUUIDObjectpublic UUID getUUIDObject() - Specified by:
- getUUIDObjectin interface- IUUIDEntity
 
 - 
getVorgang@Deprecated public Vorgang getVorgang() Deprecated.UsegetFormRecord().- Specified by:
- getVorgangin interface- IVorgangDependent
- Returns:
- The form record where this appointment was booked. This may be nullwhen the form record was deleted.
 
 - 
getZonedDateTimepublic com.google.common.collect.Range<ZonedDateTime> getZonedDateTime() - Returns:
- The date and time range of this event, with the time zone.
 
 - 
getZonedDateTimeFrompublic ZonedDateTime getZonedDateTimeFrom() - Returns:
- The start date and time of this event, with the time zone.
 
 - 
getZonedDateTimeUntilpublic ZonedDateTime getZonedDateTimeUntil() - Returns:
- The end date and time of this event, with a time zone (UTC).
 
 - 
hasFormRecordpublic boolean hasFormRecord() - Specified by:
- hasFormRecordin interface- IEffectiveAppointmentStatusProviding
- Returns:
- Whether this appointment is associated with an existing form record.
 
 - 
setAppointmentTypepublic void setAppointmentType(AppointmentType appointmentType) - Parameters:
- appointmentType- The appointment type for which this event was created.
 
 - 
setClientpublic void setClient(Mandant client) - Parameters:
- client- The client to which this event belongs.
 
 - 
setFormRecordpublic void setFormRecord(Vorgang formRecord) - Parameters:
- formRecord- The form record where this appointment was booked. This may be- nullwhen the form record was deleted.
 
 - 
setInstantpublic void setInstant(com.google.common.collect.Range<Instant> instant) - Parameters:
- instant- The new start and end point of this appointment.
 
 - 
setInstantFrompublic void setInstantFrom(Instant instantFrom) - Parameters:
- instantFrom- The new start point of this appointment.
 
 - 
setInstantUntilpublic void setInstantUntil(Instant instantUntil) - Parameters:
- instantUntil- The new end point of this appointment.
 
 - 
setMandant@Deprecated public void setMandant(Mandant client) Deprecated.UsesetClient(Mandant).- Specified by:
- setMandantin interface- IMandantDependent
- Parameters:
- client- The client to which this event belongs.
 
 - 
setStatuspublic void setStatus(EAppointmentStatus status) - Parameters:
- status- The current status of this appointment, e.g. whether it is booked, canceled etc.
 
 - 
setTimestampFrompublic void setTimestampFrom(long timestampFrom) - Parameters:
- timestampFrom- The start point of this appointment as an epoch (unix timestamp) in milliseconds.
 
 - 
setTimestampUntilpublic void setTimestampUntil(long timestampUntil) - Parameters:
- timestampUntil- The end point of this appointment as an epoch (unix timestamp) in milliseconds.
 
 - 
setUUIDpublic void setUUID(String uuid) - Specified by:
- setUUIDin interface- IUUIDEntity
 
 - 
setUUIDObjectpublic void setUUIDObject(UUID uuid) - Parameters:
- uuid- The new UUID of this appointment.
 
 - 
setVorgang@Deprecated public void setVorgang(Vorgang formRecord) Deprecated.- Parameters:
- formRecord- The form record where this appointment was booked. This may be- nullwhen the form record was deleted.
 
 - 
setZonedDateTimepublic void setZonedDateTime(com.google.common.collect.Range<ZonedDateTime> dateTime) - Parameters:
- dateTime- The start and end date time of this appointment.
 
 - 
setZonedDateTimeFrompublic void setZonedDateTimeFrom(ZonedDateTime dateTimeFrom) - Parameters:
- dateTimeFrom- The start date time of this appointment.
 
 - 
setZonedDateTimeUntilpublic void setZonedDateTimeUntil(ZonedDateTime dateTimeUntil) - Parameters:
- dateTimeUntil- The end date time of this appointment.
 
 
- 
 
-