com.canto.cumulus.prefs

Class CatalogTemplateList

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.ListPackManager

com.canto.cumulus.prefs.CatalogTemplateList

All Implemented Interfaces:

ItemManager

public class CatalogTemplateList
extends ListPackManager
implements ItemManager

This class manages a list of catalog templates. This can either be a list of server catalog templates from calling ServerSettings.getCatalogTemplates() or a list of user catalog templates from calling User.getCatalogTemplates().

Since:

8.0

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
CatalogTemplate	copy(java.lang.String newName, CatalogSettingsRoot copySource) Copies the given catalog into a new Catalog Template and stores the result under the specified name.
CatalogTemplate	copy(java.lang.String newName, CatalogSettingsRoot copySource, boolean copyDisplayNames, boolean copyDescriptions) Copies the given catalog into a new Catalog Template and stores the result under the specified name.
CatalogTemplate	copy(java.lang.String newName, CatalogTemplate copySource) Duplicates the given catalog template and stores the result under the specified name.
CatalogTemplate	copy(java.lang.String newName, CatalogTemplate copySource, boolean copyDisplayNames, boolean copyDescriptions) Duplicates the given catalog template and stores the result under the specified name.
Item	copy(java.lang.String id, Item item, boolean copyDisplayNames, boolean copyDescriptions) Duplicates the given item with the specified UID.
void	delete(CatalogTemplate setToDelete) Deletes the given catalog template.
void	delete(Item item) Deletes the given item.
CatalogTemplate	getCatalogTemplate(java.lang.String name) Returns the catalog template for the given name.
java.util.List<java.lang.String>	getCatalogTemplateNames() Return a list of catalog template names of this instance.
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.
CatalogTemplate	importSet(JPack data, SetImportDuplicatesMode duplicatesMode) Imports the given exported set data into a new set.
void	rename(java.lang.String newName, CatalogTemplate setToRename) Renames the given catalog template to the new specified name.
void	rename(java.lang.String newName, CatalogTemplate setToRename, boolean keepDisplayNames, boolean keepDescriptions) Renames the given catalog template 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(CatalogTemplate newDefaultSet) Sets the given catalog template as the default catalog template.
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 CatalogTemplate copy(java.lang.String newName,
                   CatalogTemplate copySource)
                     throws CumulusException,
                            javax.naming.InvalidNameException

Duplicates the given catalog template and stores the result under the specified name.

Parameters:

newName - the name of the new catalog template

copySource - the source catalog template to copy

Returns:

the copied catalog template

Throws:

CumulusException - in case of an error

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

copy

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

Duplicates the given catalog template and stores the result under the specified name.

Parameters:

newName - the name of the new catalog template

copySource - the source catalog template to copy

copyDisplayNames - true if display names should be copied as well

copyDescriptions - true if descriptions should be copied as well

Returns:

the copied catalog template

Throws:

CumulusException - in case of an error

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

Since:

8.5

importSet

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

Imports the given exported set data into a new set.

Parameters:

data - set that had been exported using CatalogTemplate.exportSet() before

duplicatesMode - mode to handle duplicate templates

Returns:

newly created set instance

Throws:

PermissionDeniedException - if you are not cumulus admin

CumulusException - in case of an server error

Since:

8.1

See Also:

CatalogTemplate.exportSet()

copy

public CatalogTemplate copy(java.lang.String newName,
                   CatalogSettingsRoot copySource)
                     throws CumulusException,
                            javax.naming.InvalidNameException

Copies the given catalog into a new Catalog Template and stores the result under the specified name.

Parameters:

newName - the name of the new catalog template

copySource - the source catalog to copy

Returns:

the copied catalog template

Throws:

CumulusException - in case of an error

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

copy

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

Copies the given catalog into a new Catalog Template and stores the result under the specified name.

Parameters:

newName - the name of the new catalog template

copySource - the source catalog to copy

copyDisplayNames - true if display names should be copied as well

copyDescriptions - true if descriptions should be copied as well

Returns:

the copied catalog template

Throws:

CumulusException - in case of an error

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

Since:

8.5

rename

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

Renames the given catalog template to the new specified name.

Parameters:

newName - the new name for the catalog template

setToRename - the catalog template 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,
          CatalogTemplate setToRename,
          boolean keepDisplayNames,
          boolean keepDescriptions)
            throws CumulusException,
                   javax.naming.InvalidNameException

Renames the given catalog template to the new specified name.

Parameters:

newName - the new name for the catalog template

setToRename - the catalog template 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

Since:

8.5

delete

public void delete(CatalogTemplate setToDelete)
            throws CumulusException

Deletes the given catalog template.

Parameters:

setToDelete - the catalog template to delete

Throws:

CumulusException - in case of an error

getCatalogTemplateNames

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

Return a list of catalog template names of this instance.

Returns:

a list of String

setAsDefault

public void setAsDefault(CatalogTemplate newDefaultSet)

Sets the given catalog template as the default catalog template. Only useful if this is the list of server catalog templates.

Parameters:

newDefaultSet - the new default catalog template

getCatalogTemplate

public CatalogTemplate getCatalogTemplate(java.lang.String name)

Returns the catalog template for the given name.

Parameters:

name - the name of the catalog template to return

Returns:

the catalog template or null if not found

copy

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

Description copied from interface: ItemManager

Duplicates the given item with the specified UID.

Specified by:

copy in interface ItemManager

Parameters:

id - the UID of the new item

item - 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

Description copied from interface: ItemManager

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)

Description copied from interface: ItemManager

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()

Description copied from interface: ItemManager

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

Description copied from interface: ItemManager

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)

Description copied from interface: ItemManager

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