com.canto.cumulus.prefs

Interface ItemManager

All Known Implementing Classes:

AssetActionsList, AssetHandlingSetList, AssetRelationList, BaseQueriesList, CatalogTemplateList, CategoryQueriesList, CategoryViewSetList, CollectionSetList, CropTemplatesList, EmailClassesList, EmailLayoutsList, MetadataTemplatesList, PermissionTemplatesList, PrintSetsList, RecordFilterList, RecordQueriesList, RecordViewSetList, WorkflowList

public interface ItemManager

This manager interface provides set type independent access for set management functions.

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.
void	delete(Item item) Deletes the given item.
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.
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.

Method Detail

getItem

Item getItem(java.lang.String id)

Returns the item with the specified UID.

Parameters:

id - the items UID to get

Returns:

the found item or null if not found

copy

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.

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

getItemIDs

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

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

Returns:

list of item UIDs

setAsDefault

void setAsDefault(Item item)

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

Parameters:

item - the item to be the default

delete

void delete(Item item)
            throws CumulusException

Deletes the given item.

Parameters:

item - the item to delete

Throws:

CumulusException - in case of an error

rename

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.

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

getPath

java.lang.String getPath()

Returns the path for this item manager instance.

Returns:

path for this item manager instance

Since:

8.6

getItemType

int getItemType()

Returns the item type for the items of this manager.

Returns:

item type for the items of this manager

Since:

8.6