com.canto.cumulus

Class AllCategoriesItemCollection

java.lang.Object

com.canto.cumulus.ItemCollection

com.canto.cumulus.CategoryItemCollection

com.canto.cumulus.AllCategoriesItemCollection

All Implemented Interfaces:

java.lang.AutoCloseable, java.lang.Iterable<Item>

public class AllCategoriesItemCollection
extends CategoryItemCollection

This class represents an unmutable collection of all categories that the current user is able to see. TYou can not modify the collection meaning that you can not perform a search or add or remove any category. The purpose of this class is to provide a collection to check whether a specific category exists or for mapping category ID to a category name. You get this object by calling Catalog.getAllCategoriesItemCollection().

Since:

8.0

Method Summary

Methods

Modifier and Type	Method and Description
void	close() The class must never be closed.
java.util.List<java.lang.Integer>	getCategoryItemIDs(java.lang.String query, java.util.EnumSet<FindFlag> flags)

Methods inherited from class com.canto.cumulus.CategoryItemCollection

clone, countCategoryTreeItems, countTotalCategoryTreeItems, findCategoryIDs, getCategoryItemByID, getCategoryTreeCatalogRootCategory, getCategoryTreeItemByIndex, getCategoryTreeItemIDByPath, getCategoryTreeItemIDByPath, getCategoryTreeItemIDs, getCategoryTreeItemIndex, getCategoryTreePath, getNumberOfAssignedRecords, hasCategoryTreeItem, iterator, sortCategoryIDsAccordingToCategoryTree

Methods inherited from class com.canto.cumulus.ItemCollection

addCatalogingListener, addCollectionListener, addFilter, addFilter, addGlobalCatalogingListener, addGlobalCollectionListener, addItemByID, addItemsByID, catalogAsset, catalogAsset, catalogAsset, catalogAssets, catalogAssets, catalogAssets, createItem, createItem, equals, find, find, find, find, findAll, getCatalog, getCumulusSession, getItemByID, getItemCount, getItemIDs, getItemPosition, getItemTotalCount, getLayout, getMultiSorting, getSortDirection, getSorting, getTableName, hashCode, hasItem, matchIDs, moveItem, moveItemByID, removeAllItems, removeCatalogingListener, removeCollectionListener, removeFilter, removeGlobalCatalogingListener, removeGlobalCollectionListener, removeItemsByID, setFreesorted, setMultiSorting, setSortDirection, setSorting, updateItems, updateItems, updateWantedFields, updateWantedFields

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

getCategoryItemIDs

public java.util.List<java.lang.Integer> getCategoryItemIDs(java.lang.String query,
                                                   java.util.EnumSet<FindFlag> flags)
                                                     throws QueryParserException

Throws:

QueryParserException

close

public void close()

The class must never be closed.

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class ItemCollection