com.canto.cumulus.prefs

Class BaseQueriesList

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.ListPackManager

com.canto.cumulus.prefs.BaseQueriesList

All Implemented Interfaces:

ItemManager

Direct Known Subclasses:

CategoryQueriesList, RecordQueriesList

public abstract class BaseQueriesList
extends ListPackManager
implements ItemManager

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.
Query	create(java.lang.String newName, java.lang.String queryString, boolean isComplex)
void	delete(Item item) Deletes the given item.
void	delete(Query setToDelete)
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.
abstract int	getItemType() Returns the item type for the items of this manager.
java.lang.String	getPath() Returns the path for this item manager instance.
java.util.List<java.lang.String>	getQueriesNames()
Query	getQuery(java.lang.String name)
Query	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	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

create

public Query create(java.lang.String newName,
           java.lang.String queryString,
           boolean isComplex)
             throws CumulusException,
                    javax.naming.InvalidNameException

Throws:

CumulusException

javax.naming.InvalidNameException

importSet

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

Imports the given exported set data into a new set.

Returns:

newly created set instance

Throws:

CumulusException

PermissionDeniedException

Since:

8.1

See Also:

Query.exportSet()

delete

public void delete(Query setToDelete)
            throws CumulusException

Throws:

CumulusException

getQueriesNames

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

getQuery

public Query getQuery(java.lang.String name)

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

Since:

8.6

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

Since:

8.6

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