com.canto.cumulus.prefs

Class EmailLayout

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.EmailLayout

All Implemented Interfaces:

Item

public class EmailLayout
extends BaseManager
implements Item

This class stores the settings for a single email layout.

Since:

9.2

Nested Class Summary

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
JPack	exportSet() Exports this set into a JPack.
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.
EmailLayoutAttachmentsList	getEmailLayoutAttachmentsList() Returns the manager for the attachments of this layout.
java.lang.String	getFooter(int languageID, boolean fallbackToDefault) Returns the footer for the given language id.
java.lang.String	getHeader(int languageID, boolean fallbackToDefault) Returns the header for the given language id.
java.lang.String	getID() Returns the UID of the item in the items namespace.
boolean	getIsDefault() Returns whether this is the default email layout.
GUID	getLayoutID() Returns the id of this email layout.
java.lang.String	getName() Returns the name of this email layout.
RestrictionsList	getRestrictionsList() Returns the list of roles and users that are allowed to view this email layout.
boolean	isDefault() Returns whether this item is the default item.
boolean	isSharingRestricted() Returns whether the set visibility is restricted to a group of users or roles.
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	setFooter(int languageID, java.lang.String footer) Sets the footer for the given language.
void	setHeader(int languageID, java.lang.String header) Sets the header for the given language.
void	setSharingRestricted(boolean value) Sets whether the set visibility is restricted to a group of users or roles.

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 email layout.

Returns:

name of this email layout

getLayoutID

public GUID getLayoutID()

Returns the id of this email layout.

Returns:

id of this email layout

getIsDefault

public boolean getIsDefault()

Returns whether this is the default email layout.

Returns:

true if this is the default email layout

getHeader

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

Returns the header for the given language id.

Parameters:

languageID - specifying the language for the header

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

Returns:

header value

setHeader

public void setHeader(int languageID,
             java.lang.String header)

Sets the header for the given language.

Parameters:

languageID - the language to set the header for

header - the new header

getFooter

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

Returns the footer for the given language id.

Parameters:

languageID - specifying the language for the footer

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

Returns:

footer value

setFooter

public void setFooter(int languageID,
             java.lang.String footer)

Sets the footer for the given language.

Parameters:

languageID - the language to set the footer for

footer - the new footer

getID

public java.lang.String getID()

Description copied from interface: Item

Returns the UID of the item in the items namespace.

Specified by:

getID in interface Item

Returns:

item UID

isDefault

public boolean isDefault()

Description copied from interface: Item

Returns whether this item is the default item.

Specified by:

isDefault in interface Item

Returns:

true if this is the default item

exportSet

public JPack exportSet()

Exports this set into a JPack.

Specified by:

exportSet in interface Item

Returns:

exported data as JPack

See Also:

EmailLayoutsList.importSet(com.canto.cumulus.utils.JPack, com.canto.cumulus.prefs.SetImportDuplicatesMode)

getDescription

public java.lang.String getDescription(int languageID)

Returns the description for the given language id.

Specified by:

getDescription in interface Item

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.

Specified by:

setDescription in interface Item

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.

Specified by:

getDisplayName in interface Item

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.

Specified by:

setDisplayName in interface Item

Parameters:

languageID - the language to set the display name for

displayName - the new display name

getEmailLayoutAttachmentsList

public EmailLayoutAttachmentsList getEmailLayoutAttachmentsList()

Returns the manager for the attachments of this layout.

Returns:

manager for the attachments of this layout

isSharingRestricted

public boolean isSharingRestricted()

Returns whether the set visibility is restricted to a group of users or roles.

Specified by:

isSharingRestricted in interface Item

Returns:

true if the set visibility is restricted to a group of users or roles

setSharingRestricted

public void setSharingRestricted(boolean value)

Sets whether the set visibility is restricted to a group of users or roles.

Specified by:

setSharingRestricted in interface Item

Parameters:

value - set to true if the set visibility should be restricted to a group of users or roles

getRestrictionsList

public RestrictionsList getRestrictionsList()

Returns the list of roles and users that are allowed to view this email layout. Only applicable for shared set and if isSharingRestricted() returns true.

Specified by:

getRestrictionsList in interface Item

Returns:

list of roles and users that are allowed to view this email layout