com.tibco.rta.model
Interface RetentionPolicy

All Known Subinterfaces:

MutableRetentionPolicy

public interface RetentionPolicy

Defines a retention policy for facts and hierarchies. This is used by the purge service that deletes data from the system as defined by the retention policy.

Nested Class Summary

static class

RetentionPolicy.Qualifier Qualifier to tell if the retention policy applies to a fact or to a hierarchy.

Method Summary

java.lang.String	getHierarchyName() Returns the hierarchy name for which this retention policy applies.
long	getPurgeFrequencyPeriod() Returns how often to run the purge job for this hierarchy.
java.lang.String	getPurgeTimeOfDay() The time of day when the purge timer should trigger for this hierarchy.
RetentionPolicy.Qualifier	getQualifier() Returns the associated qualifier
long	getRetentionPeriod() Returns the period in milliseconds based on retention count and retention unit.
TimeUnits.Unit	getRetentionUnit() Returns the unit of measurement of the retention count.
long	getRetentionUnitCount() Returns the unit multiplier of the retention unit.

Method Detail

getQualifier

RetentionPolicy.Qualifier getQualifier()

Returns the associated qualifier

Returns:

the associated qualifier.

getHierarchyName

java.lang.String getHierarchyName()

Returns the hierarchy name for which this retention policy applies.

Returns:

the hierarchy name for which this retention policy applies.

getRetentionUnitCount

long getRetentionUnitCount()

Returns the unit multiplier of the retention unit.

Returns:

the unit multiplier of the retention unit.

getRetentionUnit

TimeUnits.Unit getRetentionUnit()

Returns the unit of measurement of the retention count.

Returns:

the unit of measurement of the retention count.

getRetentionPeriod

long getRetentionPeriod()

Returns the period in milliseconds based on retention count and retention unit.

Returns:

the period in milliseconds based on retention count and retention unit.

getPurgeTimeOfDay

java.lang.String getPurgeTimeOfDay()

The time of day when the purge timer should trigger for this hierarchy. HHMI format HH denotes the hour of the day and MI denotes the minutes of the hour.

Returns:

the time of day when the purge timer should trigger for this hierarchy.

getPurgeFrequencyPeriod

long getPurgeFrequencyPeriod()

Returns how often to run the purge job for this hierarchy.

Returns:

the purge frequency for this hierarchy.