org.ametys.plugins.newsletter.auto

Interface AutomaticNewsletter

All Known Implementing Classes:

StaticAutomaticNewsletter

public interface AutomaticNewsletter

Interface defining an automatic newsletter service.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AutomaticNewsletter.FrequencyType The frequency type.

Method Summary

Modifier and Type	Method and Description
Collection<Integer>	getDayNumbers() Get the automatic newsletter frequency identifiers.
I18nizableText	getDescription() Get the automatic newsletter description.
Map<String,String>	getFilters() Get the filters which this automatic newsletter bases on.
AutomaticNewsletter.FrequencyType	getFrequencyType() Get the automatic newsletter frequency type.
I18nizableText	getLabel() Get the automatic newsletter label.
I18nizableText	getNewsletterTitle() Get the automatic newsletter title.

Method Detail

getLabel

I18nizableText getLabel()

Get the automatic newsletter label.

Returns:

the automatic newsletter label.

getDescription

I18nizableText getDescription()

Get the automatic newsletter description.

Returns:

the automatic newsletter description.

getNewsletterTitle

I18nizableText getNewsletterTitle()

Get the automatic newsletter title.

Returns:

the automatic newsletter title.

getFrequencyType

AutomaticNewsletter.FrequencyType getFrequencyType()

Get the automatic newsletter frequency type.

Returns:

the automatic newsletter frequency type.

getDayNumbers

Collection<Integer> getDayNumbers()

Get the automatic newsletter frequency identifiers.

Returns:

the automatic newsletter frequency identifiers.

getFilters

Map<String,String> getFilters()

Get the filters which this automatic newsletter bases on.

Returns:

a Map of filter name -> filter ID.