com.canto.cumulus.prefs

Class EmailClassPlaceholderList

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.ListPackManager

com.canto.cumulus.prefs.EmailClassPlaceholderList

public class EmailClassPlaceholderList
extends ListPackManager

This class manages a list of placeholders 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
EmailClassPlaceholder	create(java.lang.String newName) Creates a new placeholder for the given name.
void	delete(EmailClassPlaceholder placeholder) Deletes the given placeholder.
EmailClassPlaceholder	getEmailClassPlaceholder(java.lang.String name) Returns the placeholder for the given name.
java.util.List<java.lang.String>	getEmailClassPlaceholderNames() Return a list of placeholder names of this instance.
java.util.List<EmailClassPlaceholder>	getEmailClassPlaceholders() Returns all placeholders contained in this list.
static java.util.Set<java.lang.String>	getPredefinedPlaceholders() Returns all predefined placeholder names.
void	rename(java.lang.String newName, EmailClassPlaceholder placeholder) Renames the given placeholder to the new specified name.

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

create

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

Creates a new placeholder for the given name.

Parameters:

newName - the name of the new placeholder

Returns:

the copied placeholder

Throws:

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

rename

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

Renames the given placeholder to the new specified name.

Parameters:

newName - the new name for the placeholder

placeholder - the placeholder to rename

Throws:

CumulusException - in case of an error

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

delete

public void delete(EmailClassPlaceholder placeholder)
            throws CumulusException

Deletes the given placeholder.

Parameters:

placeholder - the placeholder to delete

Throws:

CumulusException - in case of an error

getEmailClassPlaceholderNames

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

Return a list of placeholder names of this instance.

Returns:

a list of String

getEmailClassPlaceholder

public EmailClassPlaceholder getEmailClassPlaceholder(java.lang.String name)

Returns the placeholder for the given name.

Parameters:

name - the name of the placeholder to return

Returns:

the placeholder or null if not found

getEmailClassPlaceholders

public java.util.List<EmailClassPlaceholder> getEmailClassPlaceholders()

Returns all placeholders contained in this list.

Returns:

all placeholders of this list

getPredefinedPlaceholders

public static java.util.Set<java.lang.String> getPredefinedPlaceholders()

Returns all predefined placeholder names.

Returns:

all predefined placeholder names