com.canto.cumulus.prefs

Class EmailClassTemplateList

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.ListPackManager

com.canto.cumulus.prefs.EmailClassTemplateList

public class EmailClassTemplateList
extends ListPackManager

This class manages a list of templates for an 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
EmailClassTemplate	copy(java.lang.String newName, EmailClassTemplate source) Duplicates the given template into a new template for the given name.
EmailClassTemplate	create(java.lang.String newName) Creates a new template for the given name.
void	delete(EmailClassTemplate template) Deletes the given template.
EmailClassTemplate	getEmailClassTemplate(java.lang.String name) Returns the template for the given name.
java.util.List<java.lang.String>	getEmailClassTemplateNames() Return a list of template names of this instance.
java.util.List<EmailClassTemplate>	getEmailClassTemplates() Returns all templates contained in this list.
void	rename(java.lang.String newName, EmailClassTemplate template) Renames the given template to the new specified name.
void	setAsDefault(EmailClassTemplate newDefault) Sets the given template as the default template.

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

copy

public EmailClassTemplate copy(java.lang.String newName,
                      EmailClassTemplate source)
                        throws javax.naming.InvalidNameException

Duplicates the given template into a new template for the given name.

Parameters:

newName - the name of the new template

Returns:

the copied template

Throws:

javax.naming.InvalidNameException - in case of an invalid or already used name

create

public EmailClassTemplate create(java.lang.String newName)
                          throws javax.naming.InvalidNameException

Creates a new template for the given name.

Parameters:

newName - the name of the new template

Returns:

the copied template

Throws:

javax.naming.InvalidNameException - in case of an invalid or already used name

rename

public void rename(java.lang.String newName,
          EmailClassTemplate template)
            throws CumulusException,
                   javax.naming.InvalidNameException

Renames the given template to the new specified name.

Parameters:

newName - the new name for the template

template - the template to rename

Throws:

CumulusException - in case of an error

javax.naming.InvalidNameException - in case of an invalid name

setAsDefault

public void setAsDefault(EmailClassTemplate newDefault)

Sets the given template as the default template.

Parameters:

newDefault - the new default template

delete

public void delete(EmailClassTemplate template)
            throws CumulusException

Deletes the given template.

Parameters:

template - the template to delete

Throws:

CumulusException - in case of an error

getEmailClassTemplateNames

public java.util.List<java.lang.String> getEmailClassTemplateNames()

Return a list of template names of this instance.

Returns:

a list of String

getEmailClassTemplate

public EmailClassTemplate getEmailClassTemplate(java.lang.String name)

Returns the template for the given name.

Parameters:

name - the name of the template to return

Returns:

the template or null if not found

getEmailClassTemplates

public java.util.List<EmailClassTemplate> getEmailClassTemplates()

Returns all templates contained in this list.

Returns:

all templates of this list