Package org.ametys.plugins.pagesubscription

Class FrequencyHelper

java.lang.Object

org.ametys.plugins.pagesubscription.FrequencyHelper

All Implemented Interfaces:

Initializable, Component, LogEnabled, Serviceable

public class FrequencyHelper
extends Object
implements Component, Serviceable, Initializable, LogEnabled

Helper for frequency

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FrequencyHelper.Frequency	The frequency type.

Field Summary

Fields

Modifier and Type	Field	Description
protected static I18nUtils	_i18nUtils	The i18n utils

Constructor Summary

Constructors

Constructor	Description
FrequencyHelper()

Method Summary

Modifier and Type	Method	Description
void	enableLogging(Logger logger)
static String	getCron(FrequencyHelper.Frequency frequency, SubscriptionType.FrequencyTiming frequencyTiming)	Get cron from frequency and timing
static List<Expression>	getDateExpressions(FrequencyHelper.Frequency frequency, ZonedDateTime notificationDate)	Get the date expressions for a given frequency to get activities before the notification date
static long	getDefaultFrequencyDay()	Get the default day of frequency (weekly or monthly)
static String	getDefaultFrequencyTime()	Get the default time of frequency (daily, weekly or monthly)
static I18nizableText	getFullLabel(FrequencyHelper.Frequency frequency, List<BroadcastChannelHelper.BroadcastChannel> channels)	Get full label with frequency and broadcast channel
static I18nizableText	getFullLabel(FrequencyHelper.Frequency frequency, List<BroadcastChannelHelper.BroadcastChannel> channels, SubscriptionType.FrequencyTiming timing)	Get full label with frequency and broadcast channel
static I18nizableText	getLabel(FrequencyHelper.Frequency frequency)	Get the label for the given frequency
static ZonedDateTime	getNotificationDate(FrequencyHelper.Frequency frequency, SubscriptionType.FrequencyTiming timing)	Get the notification date for a given frequency and timing
static I18nizableText	getSmartLabel(FrequencyHelper.Frequency frequency)	Get the smart label with day and hour of the given frequency
static I18nizableText	getSmartLabel(FrequencyHelper.Frequency frequency, SubscriptionType.FrequencyTiming timing)	Get the smart label with day and hour of the given frequency
static SubscriptionType.FrequencyTiming	getTiming(Subscription subscription)	Get the frequency timing of the subscription
void	initialize()
static void	saxFrequencies(ContentHandler contentHandler)	SAX frequencies
void	service(ServiceManager manager)

Methods inherited from class java.lang.Object

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

Field Details

_i18nUtils

protected static I18nUtils _i18nUtils

The i18n utils

Constructor Details

FrequencyHelper

public FrequencyHelper()

Method Details

enableLogging

public void enableLogging(Logger logger)

Specified by:

enableLogging in interface LogEnabled

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

getDefaultFrequencyDay

public static long getDefaultFrequencyDay()

Get the default day of frequency (weekly or monthly)

Returns:

the default day of frequency

getDefaultFrequencyTime

public static String getDefaultFrequencyTime()

Get the default time of frequency (daily, weekly or monthly)

Returns:

the default time of frequency

saxFrequencies

public static void saxFrequencies(ContentHandler contentHandler)
                           throws SAXException

SAX frequencies

Parameters:

contentHandler - the content handler to sax intos

Throws:

SAXException - if an error occured while saxing

getLabel

public static I18nizableText getLabel(FrequencyHelper.Frequency frequency)

Get the label for the given frequency

Parameters:

frequency - the frequency

Returns:

the label

getSmartLabel

public static I18nizableText getSmartLabel(FrequencyHelper.Frequency frequency)

Get the smart label with day and hour of the given frequency

Parameters:

frequency - the frequency

Returns:

the smart label

getSmartLabel

public static I18nizableText getSmartLabel(FrequencyHelper.Frequency frequency,
 SubscriptionType.FrequencyTiming timing)

Get the smart label with day and hour of the given frequency

Parameters:

frequency - the frequency

timing - the frequency timing. Can be null to get the default config param

Returns:

the smart label

getFullLabel

public static I18nizableText getFullLabel(FrequencyHelper.Frequency frequency,
 List<BroadcastChannelHelper.BroadcastChannel> channels)

Get full label with frequency and broadcast channel

Parameters:

frequency - the frequency

channels - the broadcast channels

Returns:

the frequency and broadcast channel label

getFullLabel

public static I18nizableText getFullLabel(FrequencyHelper.Frequency frequency,
 List<BroadcastChannelHelper.BroadcastChannel> channels,
 SubscriptionType.FrequencyTiming timing)

Get full label with frequency and broadcast channel

Parameters:

frequency - the frequency

channels - the broadcast channels

timing - the frequency timing of the full label. Can be null to get the default config param

Returns:

the frequency and broadcast channel label

getTiming

public static SubscriptionType.FrequencyTiming getTiming(Subscription subscription)

Get the frequency timing of the subscription

Parameters:

subscription - the subscription

Returns:

the frequency timing

getCron

public static String getCron(FrequencyHelper.Frequency frequency,
 SubscriptionType.FrequencyTiming frequencyTiming)

Get cron from frequency and timing

Parameters:

frequency - the frequency

frequencyTiming - the timing

Returns:

the cron expression

getDateExpressions

public static List<Expression> getDateExpressions(FrequencyHelper.Frequency frequency,
 ZonedDateTime notificationDate)

Get the date expressions for a given frequency to get activities before the notification date

Parameters:

frequency - the frequency

notificationDate - the notification date

Returns:

date expressions

getNotificationDate

public static ZonedDateTime getNotificationDate(FrequencyHelper.Frequency frequency,
 SubscriptionType.FrequencyTiming timing)

Get the notification date for a given frequency and timing

Parameters:

frequency - the frequency

timing - the timing

Returns:

the notification date