Package de.xima.fc.entities.interfaces

Interface ICounter

All Superinterfaces:

IDescriptionProviding, INameProviding, IUUIDEntity

All Known Implementing Classes:

ClientCounter

public interface ICounter
extends IUUIDEntity, INameProviding, IDescriptionProviding

Common interface for counter entities

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Field Summary

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

ATTR_BESCHREIBUNG, ATTR_DESCRIPTION, COL_DESCRIPTION

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

ATTR_NAME, COL_NAME

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

Method Summary

Modifier and Type	Method	Description
long	getCounterValue()
Date	getDateCreated()
Date	getDateEdited()
long	getInitialValue()
int	getResetDay()
default int	getResetHour()
default int	getResetMinute()
int	getResetMonth()
LocalTime	getResetTime()
ECounterResetType	getResetType()
long	getResetValue()
int	getResetWeekday()
boolean	isResetAutomatically()

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

getBeschreibung, getDescription

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

getName

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

getUUID, getUUIDObject, setUUID

Method Detail

getCounterValue

long getCounterValue()

Returns:

current value of the counter

getInitialValue

long getInitialValue()

Returns:

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

getDateCreated

Date getDateCreated()

Returns:

when the counter was created

getDateEdited

Date getDateEdited()

Returns:

when the counter was last edited

isResetAutomatically

boolean isResetAutomatically()

Returns:

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

getResetType

ECounterResetType getResetType()

Returns:

type of condition for resetting the counter automatically

getResetValue

long getResetValue()

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

getResetTime

LocalTime getResetTime()

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

getResetHour

default int getResetHour()

Returns:

Hour 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

getResetMinute

default int getResetMinute()

Returns:

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

getResetWeekday

int getResetWeekday()

Returns:

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

getResetDay

int getResetDay()

Returns:

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

getResetMonth

int getResetMonth()

Returns:

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