com.canto.cumulus.prefs

Class EmailClassTemplate

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.EmailClassTemplate

public class EmailClassTemplate
extends BaseManager

This class stores the settings for a single email template.

Since:

9.2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EmailClassTemplate.LayoutMode

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields inherited from class com.canto.cumulus.prefs.BaseManager

TYPE_EJP, TYPE_NATIVE

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBody(int languageID) Returns the body for the given language id.
java.lang.String	getBody(int languageID, boolean fallbackToDefault) Returns the body for the given language id.
java.lang.String	getDescription(int languageID) Returns the description for the given language id.
java.lang.String	getDisplayName(int languageID, boolean fallbackToDefaultName) Returns the display name for the given language id.
boolean	getIsDefault() Returns whether this is the default template of this class.
EmailClassTemplate.LayoutMode	getLayoutMode() Returns the layout mode to use when rendering this template.
java.lang.String	getName() Returns the name of this template.
GUID	getSpecificLayoutID() Returns the id of the layout to use when this template is configured to use a specific layout.
java.lang.String	getSubject(int languageID) Returns the subject for the given language id.
java.lang.String	getSubject(int languageID, boolean fallbackToDefault) Returns the subject for the given language id.
boolean	isEnabled() Returns whether this template is enabled and can be used.
void	setBody(int languageID, java.lang.String body) Sets the body for the given language.
void	setDescription(int languageID, java.lang.String description) Sets the description for the given language.
void	setDisplayName(int languageID, java.lang.String displayName) Sets the display name for the given language.
void	setEnabled(boolean enabled) Specifies whether this template is enabled and can be used.
void	setLayoutMode(EmailClassTemplate.LayoutMode layoutMode) Specifies the layout mode to use when rendering this template.
void	setSpecificLayoutID(GUID layoutID) Specifies the id of the layout to use when this template is configured to use a specific layout.
void	setSubject(int languageID, java.lang.String subject) Sets the subject for the given language.

Methods inherited from class com.canto.cumulus.prefs.BaseManager

addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, getPack, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, save, toString, writeAsXML

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getName

public java.lang.String getName()

Returns the name of this template.

Returns:

name of this template

isEnabled

public boolean isEnabled()

Returns whether this template is enabled and can be used.

Returns:

true if this template is enabled and can be used, false otherwise

setEnabled

public void setEnabled(boolean enabled)

Specifies whether this template is enabled and can be used.

Parameters:

enabled - true if this template is enabled and can be used, false otherwise

getIsDefault

public boolean getIsDefault()

Returns whether this is the default template of this class.

Returns:

true if this is the default template of this class

getDescription

public java.lang.String getDescription(int languageID)

Returns the description for the given language id.

Parameters:

languageID - specifying the language for the description

Returns:

description text

setDescription

public void setDescription(int languageID,
                  java.lang.String description)

Sets the description for the given language.

Parameters:

languageID - the language to set the description for

description - the new description

getDisplayName

public java.lang.String getDisplayName(int languageID,
                              boolean fallbackToDefaultName)

Returns the display name for the given language id.

Parameters:

languageID - specifying the language for the display name

fallbackToDefaultName - when set to true this method returns the default name when now localized display name is available otherwise null

Returns:

display name

setDisplayName

public void setDisplayName(int languageID,
                  java.lang.String displayName)

Sets the display name for the given language.

Parameters:

languageID - the language to set the display name for

displayName - the new display name

getSubject

public java.lang.String getSubject(int languageID)

Returns the subject for the given language id.

Parameters:

languageID - specifying the language for the subject

Returns:

subject text

getSubject

public java.lang.String getSubject(int languageID,
                          boolean fallbackToDefault)

Returns the subject for the given language id.

Parameters:

languageID - specifying the language for the subject

fallbackToDefault - if no subject for the given language can be found the default subject is returned if this is true

Returns:

subject text

setSubject

public void setSubject(int languageID,
              java.lang.String subject)

Sets the subject for the given language.

Parameters:

languageID - the language to set the subject for

subject - the new subject

getBody

public java.lang.String getBody(int languageID)

Returns the body for the given language id.

Parameters:

languageID - specifying the language for the body

Returns:

body text

getBody

public java.lang.String getBody(int languageID,
                       boolean fallbackToDefault)

Returns the body for the given language id.

Parameters:

languageID - specifying the language for the body

fallbackToDefault - if no body for the given language can be found the default body is returned if this is true

Returns:

body text

setBody

public void setBody(int languageID,
           java.lang.String body)

Sets the body for the given language.

Parameters:

languageID - the language to set the body for

body - the new body

getLayoutMode

public EmailClassTemplate.LayoutMode getLayoutMode()

Returns the layout mode to use when rendering this template.

Returns:

layout mode to use when rendering this template

setLayoutMode

public void setLayoutMode(EmailClassTemplate.LayoutMode layoutMode)

Specifies the layout mode to use when rendering this template.

Parameters:

layoutMode - layout mode to use when rendering this template

getSpecificLayoutID

public GUID getSpecificLayoutID()

Returns the id of the layout to use when this template is configured to use a specific layout.

Returns:

id of the layout to use when this template is configured to use a specific layout

setSpecificLayoutID

public void setSpecificLayoutID(GUID layoutID)

Specifies the id of the layout to use when this template is configured to use a specific layout.

Parameters:

layoutID - id of the layout to use when this template is configured to use a specific layout