Package de.xima.fc.entities

Class ClientCounter

java.lang.Object

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

de.xima.fc.entities.AbstractEntity

de.xima.fc.entities.AbstractLockableEntity

de.xima.fc.entities.ALockableEntity

de.xima.fc.entities.AClientDependentEntity

de.xima.fc.entities.ClientCounter

All Implemented Interfaces:

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

@Entity
public class ClientCounter
extends AClientDependentEntity
implements ICounter, Serializable

Counter entity in Mandant scope

Since:

7.0.0

Author:

XIMA Media GmbH

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_COUNTER_VALUE
static String	ATTR_DATE_CREATED
static String	ATTR_DATE_EDITED
static String	ATTR_INITIAL_VALUE
static String	ATTR_RESET_CONDITION_TYPE
static String	ATTR_RESET_CONDITION_VALUE
static String	ATTR_RESET_DAY
static String	ATTR_RESET_MONTH
static String	ATTR_RESET_PERIODICALLY
static String	ATTR_RESET_TIME
static String	ATTR_RESET_WEEKDAY
static String	COL_COUNTER_VALUE
static String	COL_DATE_CREATED
static String	COL_DATE_EDITED
static String	COL_INITIAL_VALUE
static String	COL_RESET_AUTOMATICALLY
static String	COL_RESET_DAY
static String	COL_RESET_MONTH
static String	COL_RESET_TIME
static String	COL_RESET_TYPE
static String	COL_RESET_VALUE
static String	COL_RESET_WEEKDAY

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

COL_CLIENTID, mandant

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.IDescriptionProviding

ATTR_BESCHREIBUNG, ATTR_DESCRIPTION, COL_DESCRIPTION

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.IMandantDependent

ATTR_CLIENT, ATTR_MANDANT, COL_CLIENT_ID

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
ClientCounter()

Method Summary

Modifier and Type	Method	Description
String	getBeschreibung()
long	getCounterValue()
Date	getDateCreated()
Date	getDateEdited()
String	getDescription()
Long	getId()
long	getInitialValue()
String	getName()
int	getResetDay()
int	getResetMonth()
LocalTime	getResetTime()
Date	getResetTimeDate()
ECounterResetType	getResetType()
long	getResetValue()
int	getResetWeekday()
DayOfWeek[]	getResetWeekdays()	Days of the week at which the counter should be reset.
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	isResetAutomatically()
void	setCounterValue(long counterValue)
void	setDateCreated(Date dateCreated)
void	setDateEdited(Date dateEdited)
void	setDescription(String description)
void	setId(Long id)	!!!WARNING: Currently values bigger Integer.MAX_VALUE or lower then Integer.MIN_VALUE will be altered to null!!!
void	setInitialValue(long initialValue)
void	setName(String name)
void	setResetAutomatically(boolean resetAutomatically)
void	setResetDay(int resetDay)
void	setResetMonth(int resetMonth)
void	setResetTime(LocalTime resetTime)
void	setResetTimeDate(Date resetTime)
void	setResetType(ECounterResetType resetType)
void	setResetValue(long resetConditionValue)
void	setResetWeekday(int resetWeekday)
void	setResetWeekdays(DayOfWeek[] resetWeekdays)
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.AClientDependentEntity

getMandant, setMandant

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

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.ICounter

getResetHour, getResetMinute

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

isPersisted

Field Detail

ATTR_COUNTER_VALUE

public static final String ATTR_COUNTER_VALUE

See Also:

Constant Field Values

ATTR_INITIAL_VALUE

public static final String ATTR_INITIAL_VALUE

See Also:

Constant Field Values

ATTR_DATE_CREATED

public static final String ATTR_DATE_CREATED

See Also:

Constant Field Values

ATTR_DATE_EDITED

public static final String ATTR_DATE_EDITED

See Also:

Constant Field Values

ATTR_RESET_PERIODICALLY

public static final String ATTR_RESET_PERIODICALLY

See Also:

Constant Field Values

ATTR_RESET_CONDITION_TYPE

public static final String ATTR_RESET_CONDITION_TYPE

See Also:

Constant Field Values

ATTR_RESET_CONDITION_VALUE

public static final String ATTR_RESET_CONDITION_VALUE

See Also:

Constant Field Values

ATTR_RESET_TIME

public static final String ATTR_RESET_TIME

See Also:

Constant Field Values

ATTR_RESET_WEEKDAY

public static final String ATTR_RESET_WEEKDAY

See Also:

Constant Field Values

ATTR_RESET_DAY

public static final String ATTR_RESET_DAY

See Also:

Constant Field Values

ATTR_RESET_MONTH

public static final String ATTR_RESET_MONTH

See Also:

Constant Field Values

COL_COUNTER_VALUE

public static final String COL_COUNTER_VALUE

See Also:

Constant Field Values

COL_INITIAL_VALUE

public static final String COL_INITIAL_VALUE

See Also:

Constant Field Values

COL_DATE_CREATED

public static final String COL_DATE_CREATED

See Also:

Constant Field Values

COL_DATE_EDITED

public static final String COL_DATE_EDITED

See Also:

Constant Field Values

COL_RESET_AUTOMATICALLY

public static final String COL_RESET_AUTOMATICALLY

See Also:

Constant Field Values

COL_RESET_TYPE

public static final String COL_RESET_TYPE

See Also:

Constant Field Values

COL_RESET_VALUE

public static final String COL_RESET_VALUE

See Also:

Constant Field Values

COL_RESET_TIME

public static final String COL_RESET_TIME

See Also:

Constant Field Values

COL_RESET_WEEKDAY

public static final String COL_RESET_WEEKDAY

See Also:

Constant Field Values

COL_RESET_DAY

public static final String COL_RESET_DAY

See Also:

Constant Field Values

COL_RESET_MONTH

public static final String COL_RESET_MONTH

See Also:

Constant Field Values

Constructor Detail

ClientCounter

public ClientCounter()

Method Detail

getId

public Long getId()

Specified by:

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

setId

public void setId(Long id)

Description copied from class: AbstractEntity

!!!WARNING: Currently values bigger Integer.MAX_VALUE or lower then Integer.MIN_VALUE will be altered to null!!!

Specified by:

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

Overrides:

setId in class AbstractEntity

Parameters:

id - Long the database-id to set

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 the entity.

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 - The UUID of the entity.

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 the entity.

setUUIDObject

public void setUUIDObject(UUID uuid)

getName

public String getName()

Specified by:

getName in interface INameProviding

Returns:

The name of this object.

setName

public void setName(String name)

getDescription

public String getDescription()

Specified by:

getDescription in interface IDescriptionProviding

Returns:

A human-readable description for this object.

setDescription

public void setDescription(String description)

getBeschreibung

public String getBeschreibung()

Specified by:

getBeschreibung in interface IDescriptionProviding

getCounterValue

public long getCounterValue()

Specified by:

getCounterValue in interface ICounter

Returns:

current value of the counter

setCounterValue

public void setCounterValue(long counterValue)

getInitialValue

public long getInitialValue()

Specified by:

getInitialValue in interface ICounter

Returns:

value the counter should be reset to (directly or automatically)

setInitialValue

public void setInitialValue(long initialValue)

getDateCreated

public Date getDateCreated()

Specified by:

getDateCreated in interface ICounter

Returns:

when the counter was created

setDateCreated

public void setDateCreated(Date dateCreated)

getDateEdited

public Date getDateEdited()

Specified by:

getDateEdited in interface ICounter

Returns:

when the counter was last edited

setDateEdited

public void setDateEdited(Date dateEdited)

isResetAutomatically

public boolean isResetAutomatically()

Specified by:

isResetAutomatically in interface ICounter

Returns:

whether or not the counter should reset itself automatically according to its reset configuration

setResetAutomatically

public void setResetAutomatically(boolean resetAutomatically)

getResetType

public ECounterResetType getResetType()

Specified by:

getResetType in interface ICounter

Returns:

type of condition for resetting the counter automatically

setResetType

public void setResetType(ECounterResetType resetType)

getResetValue

public long getResetValue()

Specified by:

getResetValue in interface ICounter

Returns:

value that needs to be met in order to trigger a counter reset. Only applicable for reset types ECounterResetType.VALUE_GREATER_EQUAL & ECounterResetType.VALUE_LESSER_EQUAL

setResetValue

public void setResetValue(long resetConditionValue)

getResetTime

public LocalTime getResetTime()

Specified by:

getResetTime in interface ICounter

Returns:

time of the day at which the counter should be reset. Only applicable for reset types ECounterResetType.TIME_DAILY, ECounterResetType.TIME_WEEKLY, ECounterResetType.TIME_MONTHLY & ECounterResetType.TIME_YEARLY

setResetTime

public void setResetTime(LocalTime resetTime)

getResetTimeDate

public Date getResetTimeDate()

Returns:

The reset time as a date

setResetTimeDate

public void setResetTimeDate(Date resetTime)

getResetWeekday

public int getResetWeekday()

Specified by:

getResetWeekday in interface ICounter

Returns:

Days of the week at which the counter should be reset, returned as a an XORed int

setResetWeekday

public void setResetWeekday(int resetWeekday)

getResetWeekdays

public DayOfWeek[] getResetWeekdays()

Days of the week at which the counter should be reset. Only applicable for reset type ECounterResetType.TIME_WEEKLY

setResetWeekdays

public void setResetWeekdays(DayOfWeek[] resetWeekdays)

getResetDay

public int getResetDay()

Specified by:

getResetDay in interface ICounter

Returns:

Day of the month at which the counter should be reset. Only applicable for reset types ECounterResetType.TIME_MONTHLY & ECounterResetType.TIME_YEARLY

setResetDay

public void setResetDay(int resetDay)

getResetMonth

public int getResetMonth()

Specified by:

getResetMonth in interface ICounter

Returns:

Month of the year at which the counter should be reset. Only applicable for reset type ECounterResetType.TIME_YEARLY

setResetMonth

public void setResetMonth(int resetMonth)