com.canto.cumulus.prefs

Class RecordViewSetList

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.ListPackManager

com.canto.cumulus.prefs.RecordViewSetList

All Implemented Interfaces:

ItemManager

public class RecordViewSetList
extends ListPackManager
implements ItemManager

This class manages a list of record view sets. This can either be a list of server record view sets from calling ServerSettings.getRecordViewSetList() or a list of user record view sets from calling User.getRecordViewSetList().

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
Item	copy(java.lang.String newID, Item src, boolean copyDisplayNames, boolean copyDescriptions) Duplicates the given item with the specified UID.
RecordViewSet	copy(java.lang.String newName, RecordViewSet copySource) Duplicates the given record view set and stores the result under the specified name.
RecordViewSet	copy(java.lang.String newName, RecordViewSet copySource, boolean copyDisplayNames, boolean copyDescriptions) Duplicates the given record view set and stores the result under the specified name.
void	delete(Item item) Deletes the given item.
void	delete(RecordViewSet setToDelete) Deletes the given record view set.
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.
RecordViewSet	getRecordViewSet(java.lang.String name) Returns the record view set for the given name.
java.util.List<java.lang.String>	getRecordViewSetNames() Return a list of record view set names of this instance.
java.util.List<RecordViewSet>	getRecordViewSets() Returns all sets contained in this list.
RecordViewSet	importSet(JPack data, SetImportDuplicatesMode duplicatesMode) Imports the given exported set data into a new set.
void	rename(java.lang.String newID, Item item, boolean keepDisplayNames, boolean keepDescriptions) Renames the given item to the new UID.
void	rename(java.lang.String newName, RecordViewSet setToRename) Renames the given record view set to the new specified name.
void	rename(java.lang.String newName, RecordViewSet setToRename, boolean keepDisplayNames, boolean keepDescriptions) Renames the given record view set to the new specified name.
void	setAsDefault(Item item) Sets the given item to be the default item.
void	setAsDefault(RecordViewSet newDefaultSet) Sets the given set as the default record view set.

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

Duplicates the given record view set 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 RecordViewSet copy(java.lang.String newName,
                 RecordViewSet copySource,
                 boolean copyDisplayNames,
                 boolean copyDescriptions)
                   throws CumulusException,
                          javax.naming.InvalidNameException

Duplicates the given record view set and stores the result under the specified name.

Parameters:

newName - the name of the new set

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

Since:

8.5

importSet

public RecordViewSet 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 RecordViewSet.exportSet() before

duplicatesMode - mode to handle duplicate sets

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:

RecordViewSet.exportSet()

setAsDefault

public void setAsDefault(RecordViewSet newDefaultSet)

Sets the given set as the default record view set. Only useful if this is the list of server record view sets.

Parameters:

newDefaultSet - the new default record view set

rename

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

Renames the given record view set to the new specified name.

Parameters:

newName - the new name for the set

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

Renames the given record view set to the new specified name.

Parameters:

newName - the new name for the set

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

Since:

8.5

delete

public void delete(RecordViewSet setToDelete)
            throws CumulusException

Deletes the given record view set.

Parameters:

setToDelete - the set to delete

Throws:

CumulusException - in case of an error

getRecordViewSetNames

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

Return a list of record view set names of this instance.

Returns:

a list of String

getRecordViewSet

public RecordViewSet getRecordViewSet(java.lang.String name)

Returns the record view set for the given name.

Parameters:

name - the name of the set to return

Returns:

the set or null if not found

getRecordViewSets

public java.util.List<RecordViewSet> getRecordViewSets()

Returns all sets contained in this list.

Returns:

all sets of this list

Since:

8.5.2

copy

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

Duplicates the given item with the specified UID.

Specified by:

copy in interface ItemManager

Parameters:

newID - the UID 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