com.canto.cumulus.prefs

Class EmailLayoutsList

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.ListPackManager

com.canto.cumulus.prefs.EmailLayoutsList

All Implemented Interfaces:

ItemManager

public class EmailLayoutsList
extends ListPackManager
implements ItemManager

This layout manages a list of email layouts.

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
EmailLayout	copy(java.lang.String newName, EmailLayout copySource) Duplicates the given email layout and stores the result under the specified name.
EmailLayout	copy(java.lang.String newName, EmailLayout copySource, boolean copyDisplayNames, boolean copyDescriptions) Duplicates the given email layout and stores the result under the specified name.
Item	copy(java.lang.String newID, Item src, boolean copyDisplayNames, boolean copyDescriptions) Duplicates the given email layout with the specified layout ID.
void	delete(EmailLayout emailLayout) Deletes the given email layout.
void	delete(Item item) Deletes the given item.
EmailLayout	getDefaultEmailLayout() Returns the default email layout.
EmailLayout	getEmailLayout(GUID layoutID) Returns the email layout for the given id.
EmailLayout	getEmailLayout(java.lang.String name) Returns the email layout for the given name.
java.util.Set<GUID>	getEmailLayoutClassIDs() Return a mapping of all contained email classes, with their internal ID pointing to their name.
java.util.List<java.lang.String>	getEmailLayoutNames() Return a list of email layout names of this instance.
java.util.List<EmailLayout>	getEmailLayouts() Returns all email layouts contained in this list.
Item	getItem(java.lang.String id) Returns the item with the specified UID.
java.util.Collection<java.lang.String>	getItemIDs() Returns the list of item UIDs that are available by this manager instance.
int	getItemType() Returns the item type for the items of this manager.
java.lang.String	getPath() Returns the path for this item manager instance.
EmailLayout	importSet(JPack data, SetImportDuplicatesMode duplicatesMode) Imports the given exported email layout data into a new email layout.
void	rename(java.lang.String newName, EmailLayout emailLayout) Renames the given email layout to the new specified name.
void	rename(java.lang.String newName, EmailLayout emailLayout, boolean keepDisplayNames, boolean keepDescriptions) Renames the given email layout to the new specified name.
void	rename(java.lang.String newID, Item item, boolean keepDisplayNames, boolean keepDescriptions) Renames the given item to the new UID.
void	setAsDefault(EmailLayout newDefault) Sets the given email layout as the default email layout.
void	setAsDefault(Item item) Sets the given item to be the default item.

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 EmailLayout copy(java.lang.String newName,
               EmailLayout copySource)
                 throws CumulusException,
                        javax.naming.InvalidNameException

Duplicates the given email layout and stores the result under the specified name.

Parameters:

newName - the name of the new set

copySource - the source set to copy

Returns:

the copied set

Throws:

CumulusException - in case of an error

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

copy

public EmailLayout copy(java.lang.String newName,
               EmailLayout copySource,
               boolean copyDisplayNames,
               boolean copyDescriptions)
                 throws CumulusException,
                        javax.naming.InvalidNameException

Duplicates the given email layout and stores the result under the specified name.

Parameters:

newName - the name of the new email layout

copySource - the source set to copy

copyDisplayNames - true if display names should be copied as well

copyDescriptions - true if descriptions should be copied as well

Returns:

the copied set

Throws:

CumulusException - in case of an error

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

importSet

public EmailLayout importSet(JPack data,
                    SetImportDuplicatesMode duplicatesMode)
                      throws CumulusException,
                             PermissionDeniedException

Imports the given exported email layout data into a new email layout.

Parameters:

data - email layout that had been exported using EmailLayout.exportSet() before

duplicatesMode - mode to handle duplicate sets

Returns:

newly created email layout instance

Throws:

PermissionDeniedException - if you are not cumulus admin

CumulusException - in case of an server error

See Also:

EmailLayout.exportSet()

setAsDefault

public void setAsDefault(EmailLayout newDefault)

Sets the given email layout as the default email layout.

Parameters:

newDefault - the new default email layout

rename

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

Renames the given email layout to the new specified name.

Parameters:

newName - the new name for the set

emailLayout - the email layout to rename

Throws:

CumulusException - in case of an error

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

rename

public void rename(java.lang.String newName,
          EmailLayout emailLayout,
          boolean keepDisplayNames,
          boolean keepDescriptions)
            throws CumulusException,
                   javax.naming.InvalidNameException

Renames the given email layout to the new specified name.

Parameters:

newName - the new name for the set

emailLayout - the set to rename

keepDisplayNames - true if display names should be kept

keepDescriptions - true if descriptions should be kept

Throws:

CumulusException - in case of an error

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

delete

public void delete(EmailLayout emailLayout)
            throws CumulusException

Deletes the given email layout.

Parameters:

emailLayout - the email layout to delete

Throws:

CumulusException - in case of an error

getEmailLayoutNames

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

Return a list of email layout names of this instance.

Returns:

a list of String

getEmailLayout

public EmailLayout getEmailLayout(java.lang.String name)

Returns the email layout for the given name.

Parameters:

name - the name of the email layout to return

Returns:

the email layout or null if not found

getEmailLayout

public EmailLayout getEmailLayout(GUID layoutID)

Returns the email layout for the given id.

Parameters:

layoutID - the id of the email layout to return

Returns:

the email layout or null if not found

getDefaultEmailLayout

public EmailLayout getDefaultEmailLayout()

Returns the default email layout.

Returns:

the default email layout or null if not found

getEmailLayouts

public java.util.List<EmailLayout> getEmailLayouts()

Returns all email layouts contained in this list.

Returns:

all email layouts of this list

getEmailLayoutClassIDs

public java.util.Set<GUID> getEmailLayoutClassIDs()

Return a mapping of all contained email classes, with their internal ID pointing to their name.

Returns:

mapping of all contained email classes

copy

public Item copy(java.lang.String newID,
        Item src,
        boolean copyDisplayNames,
        boolean copyDescriptions)
          throws javax.naming.InvalidNameException,
                 CumulusException

Duplicates the given email layout with the specified layout ID.

Specified by:

copy in interface ItemManager

Parameters:

newID - the ID of the new item

src - the item to copy

copyDisplayNames - true if display names should be copied as well

copyDescriptions - true if descriptions should be copied as well

Returns:

the copied item instance

Throws:

javax.naming.InvalidNameException - if the name is already in use or invalid for another reason

CumulusException - in case of an error

delete

public void delete(Item item)
            throws CumulusException

Deletes the given item.

Specified by:

delete in interface ItemManager

Parameters:

item - the item to delete

Throws:

CumulusException - in case of an error

getItem

public Item getItem(java.lang.String id)

Returns the item with the specified UID.

Specified by:

getItem in interface ItemManager

Parameters:

id - the items UID to get

Returns:

the found item or null if not found

getItemIDs

public java.util.Collection<java.lang.String> getItemIDs()

Returns the list of item UIDs that are available by this manager instance.

Specified by:

getItemIDs in interface ItemManager

Returns:

list of item UIDs

rename

public void rename(java.lang.String newID,
          Item item,
          boolean keepDisplayNames,
          boolean keepDescriptions)
            throws javax.naming.InvalidNameException,
                   CumulusException

Renames the given item to the new UID.

Specified by:

rename in interface ItemManager

Parameters:

newID - the new item UID

item - the item to rename

keepDisplayNames - true if display names should be kept

keepDescriptions - true if descriptions should be kept

Throws:

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

CumulusException - in case of another error

setAsDefault

public void setAsDefault(Item item)

Sets the given item to be the default item. This makes only sense for shared items.

Specified by:

setAsDefault in interface ItemManager

Parameters:

item - the item to be the default

getPath

public java.lang.String getPath()

Description copied from interface: ItemManager

Returns the path for this item manager instance.

Specified by:

getPath in interface ItemManager

Returns:

path for this item manager instance

getItemType

public int getItemType()

Description copied from interface: ItemManager

Returns the item type for the items of this manager.

Specified by:

getItemType in interface ItemManager

Returns:

item type for the items of this manager