Package org.deltava.beans.system

Class InactivityPurge

java.lang.Object

org.deltava.beans.DatabaseBean

org.deltava.beans.system.InactivityPurge

All Implemented Interfaces:

Serializable, Comparable<Object>, IDBean, Cacheable

public class InactivityPurge
extends DatabaseBean

A system bean to store User Inactivity Purge data.

Since:

1.0

Version:

7.0

Author:

Luke

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
InactivityPurge(int id)	Creates a new Inactivity Purge entry.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Object o2)	Compares two InactivityPurge beans by comparing their Purge Dates.
int	getInterval()	Returns the number of days this entry should be retained for.
Instant	getPurgeDate()	Returns the date the user will be marked Inactive.
boolean	isNotified()	Returns whether the Pilot has been marked of impending inactivity.
void	setInterval(int days)	Updates the purge interval.
void	setNotify(boolean notified)	Marks the Pilot as being notified of the impending purge.
void	setPurgeDate(Instant dt)	Updates the date the Pilot will be marked Inactive.

Methods inherited from class org.deltava.beans.DatabaseBean

cacheKey, equals, getHexID, getID, hashCode, setID, validateID, validateID

Methods inherited from class java.lang.Object

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

Constructor Details

InactivityPurge

public InactivityPurge(int id)

Creates a new Inactivity Purge entry.

Parameters:

id - the Pilot's database ID

Method Details

getPurgeDate

public Instant getPurgeDate()

Returns the date the user will be marked Inactive.

Returns:

the date/time

See Also:

• setPurgeDate(Instant)

getInterval

public int getInterval()

Returns the number of days this entry should be retained for. This should not be confused with the purge date property, since it is not related. It is designed to give history information when purging a user and is not used in any programmatic way.

Returns:

the number of days before the user is purged

See Also:

• setInterval(int)

isNotified

public boolean isNotified()

Returns whether the Pilot has been marked of impending inactivity.

Returns:

TRUE if a notification message was sent, otherwise FALSE

See Also:

• setNotify(boolean)

setNotify

public void setNotify(boolean notified)

Marks the Pilot as being notified of the impending purge.

Parameters:

notified - TRUE if the Pilot was notified, otherwise FALS

See Also:

• isNotified()

setInterval

public void setInterval(int days)

Updates the purge interval.

Parameters:

days - the number of days this entry will remain active

See Also:

• getInterval()

setPurgeDate

public void setPurgeDate(Instant dt)

Updates the date the Pilot will be marked Inactive.

Parameters:

dt - the date/time the Pilot will be marked inactive

See Also:

• getPurgeDate()

compareTo

public int compareTo(Object o2)

Compares two InactivityPurge beans by comparing their Purge Dates.

Specified by:

compareTo in interface Comparable<Object>

Overrides:

compareTo in class DatabaseBean

See Also:

• Comparable.compareTo(Object)