NewsletterTemplate (Ametys 4.5.x - API)

java.lang.Object
- org.apache.avalon.framework.logger.AbstractLogEnabled
- - org.ametys.plugins.newsletter.category.NewsletterTemplate

All Implemented Interfaces:: Component, LogEnabled, Serviceable

public class NewsletterTemplate
extends AbstractLogEnabled
implements Serviceable, Component

Represent a newsletter template.

Constructor Summary

Constructors
Constructor Description

NewsletterTemplate(String skinId, String templateId)
Creates a template

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`I18nizableText`	`getDescription()`	The template description
`String`	`getId()`	The template id
`I18nizableText`	`getLabel()`	The template label
`String`	`getLargeImage()`	The large image file uri
`String`	`getMediumImage()`	The medium image file uri
`String`	`getSmallImage()`	The small image file uri
`void`	`refreshValues()`	Refresh the configuration values
`void`	`service(ServiceManager manager)`

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - NewsletterTemplate
```
public NewsletterTemplate(String skinId,
                          String templateId)
```
    Creates a template
    
    Parameters:
    
    skinId - The skin id
    
    templateId - The template id
- Method Detail
  - service
```
public void service(ServiceManager manager)
             throws ServiceException
```
    Specified by:
    
    service in interface Serviceable
    
    Throws:
    
    ServiceException
  - getId
```
public String getId()
```
    The template id
    
    Returns:
    
    the id
  - getLabel
```
public I18nizableText getLabel()
```
    The template label
    
    Returns:
    
    The label
  - getDescription
```
public I18nizableText getDescription()
```
    The template description
    
    Returns:
    
    The description. Can not be null but can be empty
  - getSmallImage
```
public String getSmallImage()
```
    The small image file uri
    
    Returns:
    
    The small image file uri
  - getMediumImage
```
public String getMediumImage()
```
    The medium image file uri
    
    Returns:
    
    The medium image file uri
  - getLargeImage
```
public String getLargeImage()
```
    The large image file uri
    
    Returns:
    
    The large image file uri
  - refreshValues
```
public void refreshValues()
```
    Refresh the configuration values