com.canto.cumulus.prefs

Class EmailClass

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.EmailClass

All Implemented Interfaces:

Item

public class EmailClass
extends BaseManager
implements Item

This class stores the settings for a single email class.

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.
GUID	getClassID() Returns the class id of this email class.
java.lang.String	getDefaultBody(int languageID) Returns the default body for the given language id.
java.lang.String	getDefaultSubject(int languageID) Returns the default subject 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.
EmailClassPlaceholderList	getEmailClassPlaceholderList() Returns the manager for the list of placeholders.
EmailClassTemplateList	getEmailClassTemplateList() Returns the manager for the list of templates for this class.
java.lang.String	getID() Returns the UID of the item in the items namespace.
boolean	getIsDefault() Returns whether this is the default email class.
java.lang.String	getName() Returns the name of this email class.
RestrictionsList	getRestrictionsList() Returns the list of roles and users that are allowed to view this email class.
boolean	isCustomClass() Returns whether this is a custom class.
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	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

getClassID

public GUID getClassID()

Returns the class id of this email class.

Returns:

id of this email class

getName

public java.lang.String getName()

Returns the name of this email class.

Returns:

name of this email class

getIsDefault

public boolean getIsDefault()

Returns whether this is the default email class.

Returns:

true if this is the default email class

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

isCustomClass

public boolean isCustomClass()

Returns whether this is a custom class. Custom classes can be reconfigured by the administrator.

Returns:

true if this is a custom class, false otherwise

exportSet

public JPack exportSet()

Exports this set into a JPack.

Specified by:

exportSet in interface Item

Returns:

exported data as JPack

See Also:

EmailClassesList.importSet(com.canto.cumulus.utils.JPack, 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

getDefaultSubject

public java.lang.String getDefaultSubject(int languageID)

Returns the default subject for the given language id.

Parameters:

languageID - specifying the language for the default subject

Returns:

default subject text

getDefaultBody

public java.lang.String getDefaultBody(int languageID)

Returns the default body for the given language id.

Parameters:

languageID - specifying the language for the default body

Returns:

default body text

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

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 class. 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 class

getEmailClassPlaceholderList

public EmailClassPlaceholderList getEmailClassPlaceholderList()

Returns the manager for the list of placeholders.

Returns:

manager for the list of placeholders

getEmailClassTemplateList

public EmailClassTemplateList getEmailClassTemplateList()

Returns the manager for the list of templates for this class.

Returns:

manager for the list of templates