com.tibco.rta.model.mutable
Interface MutableRetentionPolicy

All Superinterfaces:

RetentionPolicy

public interface MutableRetentionPolicy
extends RetentionPolicy

This represents a retention policy that can be modified via the API.

Nested Class Summary

Nested classes/interfaces inherited from interface com.tibco.rta.model.RetentionPolicy

RetentionPolicy.Qualifier

Method Summary

void	setHierarchyName(java.lang.String hierarchyName) Sets the name of the hierarchy for which this policy is being defined.
void	setPurgeTimeOfDay(java.lang.String purgeTimeOfDay) Sets the purge time of the day in HHMI format, where HH is the hours of the day and MI is the minutes of the hour.
void	setQualifier(RetentionPolicy.Qualifier qualifier) Defines the qualifier of the retention policy.
void	setRetentionUnit(TimeUnits.Unit timeUnit) Sets the unit of measurement for the unit multiplier.
void	setRetentionUnitCount(long unitCount) Sets a retention policy unit multiplier.

Methods inherited from interface com.tibco.rta.model.RetentionPolicy

getHierarchyName, getPurgeFrequencyPeriod, getPurgeTimeOfDay, getQualifier, getRetentionPeriod, getRetentionUnit, getRetentionUnitCount

Method Detail

setQualifier

void setQualifier(RetentionPolicy.Qualifier qualifier)

Defines the qualifier of the retention policy.

Parameters:

qualifier - Whether this policy is for facts of for hierarchies.

setRetentionUnitCount

void setRetentionUnitCount(long unitCount)

Sets a retention policy unit multiplier.

Parameters:

unitCount - unit multiplier

setRetentionUnit

void setRetentionUnit(TimeUnits.Unit timeUnit)

Sets the unit of measurement for the unit multiplier.

Parameters:

timeUnit - the unit of measurement to use.

setPurgeTimeOfDay

void setPurgeTimeOfDay(java.lang.String purgeTimeOfDay)

Sets the purge time of the day in HHMI format, where HH is the hours of the day and MI is the minutes of the hour.

Parameters:

purgeTimeOfDay - the purge time of the day.

setHierarchyName

void setHierarchyName(java.lang.String hierarchyName)

Sets the name of the hierarchy for which this policy is being defined.

Parameters:

hierarchyName - the name of the hierarchy for which this policy is being defined.