com.canto.cumulus.prefs

Class EmailClassesList

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.ListPackManager

com.canto.cumulus.prefs.EmailClassesList

All Implemented Interfaces:

ItemManager

public class EmailClassesList
extends ListPackManager
implements ItemManager

This class manages a list of email classes.

Since:

9.2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EmailClassesList.PredefinedClassID

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
EmailClass	copy(java.lang.String newName, EmailClass copySource) Duplicates the given email class and stores the result under the specified name.
EmailClass	copy(java.lang.String newName, EmailClass copySource, boolean copyDisplayNames, boolean copyDescriptions) Duplicates the given email class and stores the result under the specified name.
Item	copy(java.lang.String newID, Item src, boolean copyDisplayNames, boolean copyDescriptions) Duplicates the given email class with the specified class ID.
void	delete(EmailClass emailClass) Deletes the given email class.
void	delete(Item item) Deletes the given item.
EmailClass	getEmailClass(GUID id) Returns the email class for the given class id.
EmailClass	getEmailClass(java.lang.String name) Returns the email class for the given name.
java.util.List<EmailClass>	getEmailClasses() Returns all email classes contained in this list.
java.util.List<java.lang.String>	getEmailClassesNames() Return a list of email classes names of this instance.
java.util.Set<GUID>	getEmailClassIDs() Return a mapping of all contained email classes, with their internal ID pointing to their name.
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.
EmailClass	importSet(JPack data, SetImportDuplicatesMode duplicatesMode) Imports the given exported email class data into a new email class.
void	rename(java.lang.String newName, EmailClass emailClass) Renames the given email class to the new specified name.
void	rename(java.lang.String newName, EmailClass emailClass, boolean keepDisplayNames, boolean keepDescriptions) Renames the given email class 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(EmailClass newDefault) Sets the given email class as the default email class.
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 EmailClass copy(java.lang.String newName,
              EmailClass copySource)
                throws CumulusException,
                       javax.naming.InvalidNameException

Duplicates the given email class and stores the result under the specified name. The copied email class gets a new class ID assigned and is marked as user email class.

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

Duplicates the given email class and stores the result under the specified name. The copied email class gets a class ID assigned and is marked as user email class.

Parameters:

newName - the name of the new email class

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 EmailClass importSet(JPack data,
                   SetImportDuplicatesMode duplicatesMode)
                     throws CumulusException,
                            PermissionDeniedException

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

Parameters:

data - email class that had been exported using EmailClass.exportSet() before

duplicatesMode - mode to handle duplicate sets

Returns:

newly created email class instance

Throws:

PermissionDeniedException - if you are not cumulus admin

CumulusException - in case of an server error

See Also:

EmailClass.exportSet()

setAsDefault

public void setAsDefault(EmailClass newDefault)

Sets the given email class as the default email class.

Parameters:

newDefault - the new default email class

rename

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

Renames the given email class to the new specified name.

Parameters:

newName - the new name for the set

emailClass - the email class 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,
          EmailClass emailClass,
          boolean keepDisplayNames,
          boolean keepDescriptions)
            throws CumulusException,
                   javax.naming.InvalidNameException

Renames the given email class to the new specified name.

Parameters:

newName - the new name for the set

emailClass - 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(EmailClass emailClass)
            throws CumulusException

Deletes the given email class.

Parameters:

emailClass - the email class to delete

Throws:

CumulusException - in case of an error

getEmailClassesNames

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

Return a list of email classes names of this instance.

Returns:

a list of String

getEmailClassIDs

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

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

Returns:

mapping of all contained email classes

getEmailClass

public EmailClass getEmailClass(java.lang.String name)

Returns the email class for the given name.

Parameters:

name - the name of the email class to return

Returns:

the email class or null if not found

getEmailClass

public EmailClass getEmailClass(GUID id)

Returns the email class for the given class id.

Parameters:

id - the class id of the email class to return

Returns:

the email class or null if not found

getEmailClasses

public java.util.List<EmailClass> getEmailClasses()

Returns all email classes contained in this list.

Returns:

all email classes of this list

copy

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

Duplicates the given email class with the specified class 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