Uses of Class
com.canto.cumulus.ItemCollection

Packages that use ItemCollection

Package	Description
com.canto.cumulus	The base package of the Cumulus Java Classes.
com.canto.cumulus.db.permissions
com.canto.cumulus.db.subscriptions
com.canto.cumulus.fieldvalue	Wrapper clsses for field values of the Cumulus Java Classes.
com.canto.cumulus.utils	The Cumulus utilities package.

Uses of ItemCollection in com.canto.cumulus

Subclasses of ItemCollection in com.canto.cumulus

Modifier and Type	Class and Description
class	AllCategoriesItemCollection This class represents an unmutable collection of all categories that the current user is able to see.
class	CategoryItemCollection This class represents the categories of a Cumulus catalog.
class	RecordItemCollection A collection of RecordItem objects of a Cumulus catalog.

Methods in com.canto.cumulus that return ItemCollection

Modifier and Type	Method and Description
ItemCollection	ItemCollection.clone() Create a clone of this collection.
ItemCollection	Server.getAllVocabulariesItemCollection() Returns an ItemCollection containing all items of the $Vocabulary catalog.
ItemCollection	FieldDefinition.getAllVocabulariesItemCollection() Returns an ItemCollection containing all items of the $Vocabulary catalog.
ItemCollection	Catalog.getAllVocabulariesItemCollection() Returns an ItemCollection containing all items of the $Vocabulary catalog.
ItemCollection	Item.getItemCollection() The item collection that this item is from.
ItemCollection	MultiItemCollection.getItemCollection(int catalogID) Return the contained ItemCollection for the given catalog ID.
ItemCollection	Item.getTableValue(GUID fieldUID) Get the contents of a field of type "Table" which is an ItemCollection that contains all items of the sub-table belonging to this item.
ItemCollection	FieldDefinition.getVocabularyItemCollection() Returns an empty ItemCollection of the $Vocabulary catalog that has set the defined query (see FieldDefinition.getVocabularyQuery()) as filter.
ItemCollection	Catalog.newItemCollection(java.lang.String tableName, boolean findAllItems) Create a new ItemCollection for the given table and optionally fill in all items that are accessible to the current user.
ItemCollection	Catalog.newItemCollection(java.lang.String tableName, java.lang.String query, java.util.EnumSet<FindFlag> flags, java.util.Locale locale) Returns a newly created collection that is filled by executing the given query.
ItemCollection	Server.newStatisticsItemCollection(java.lang.String query, java.util.Locale locale) Create a new ItemCollection and fill it with the items found by the given query.

Methods in com.canto.cumulus with parameters of type ItemCollection

Modifier and Type	Method and Description
void	MultiItemCollection.addItemCollection(ItemCollection itemCollection) Add an ItemCollection to this MultiItemCollection.
boolean	UserContext.hasPermission(java.lang.String permission, ItemCollection itemCollection) Returns whether the current user has the specified permission on the given item collection.

Method parameters in com.canto.cumulus with type arguments of type ItemCollection

Modifier and Type	Method and Description
void	ItemCollection.addCatalogingListener(CatalogingListener<ItemCollection> catalogingListener) Add a listener that is called whenever someone catalogs into this ItemCollection.
void	ItemCollection.addCollectionListener(CollectionListener<ItemCollection> listener) Add a listener that is called whenever a single item is added / updated / deleted, or the whole content has changed, or the sorting has changed for this ItemCollection.
static void	ItemCollection.addGlobalCatalogingListener(CatalogingListener<ItemCollection> catalogingListener) Add a listener that is called whenever someone catalogs into any ItemCollection.
static void	ItemCollection.addGlobalCollectionListener(CollectionListener<ItemCollection> listener) Add a listener that is called whenever a single item is added / updated / deleted, or the whole content of has changed, or the sorting has changed for any ItemCollection.
void	ItemCollection.catalogAsset(Asset asset, java.lang.String assetHandlingSet, java.lang.String permissionTemplate, java.util.EnumSet<CatalogingFlag> catalogingFlags, CatalogingListener<ItemCollection> catalogingListener) Catalog a single asset to this collection.
void	ItemCollection.catalogAsset(Asset asset, java.lang.String assetHandlingSet, java.lang.String permissionTemplate, java.util.EnumSet<CatalogingFlag> catalogingFlags, Item additionalFieldValuesItem, java.util.Map<GUID,MetadataTemplateEntry.ValueFillMode> additionalFieldValuesFillMode, CatalogingListener<ItemCollection> catalogingListener) Catalog a single asset to this collection.
void	ItemCollection.catalogAsset(Asset asset, java.lang.String assetHandlingSet, java.lang.String permissionTemplate, java.util.EnumSet<CatalogingFlag> catalogingFlags, java.util.Set<java.lang.Integer> assignCategoryIDs, CatalogingListener<ItemCollection> catalogingListener) Catalog a single asset to this collection.
void	ItemCollection.catalogAssets(AssetCollection assetCollection, java.lang.String assetHandlingSet, java.lang.String permissionTemplate, java.util.EnumSet<CatalogingFlag> catalogingFlags, CatalogingListener<ItemCollection> catalogingListener) Catalog a collection of assets to this collection.
void	ItemCollection.catalogAssets(AssetCollection assetCollection, java.lang.String assetHandlingSet, java.lang.String permissionTemplate, java.util.EnumSet<CatalogingFlag> catalogingFlags, Item additionalFieldValuesItem, java.util.Map<GUID,MetadataTemplateEntry.ValueFillMode> additionalFieldValuesFillMode, CatalogingListener<ItemCollection> catalogingListener) Catalog a collection of assets to this collection.
void	ItemCollection.catalogAssets(AssetCollection assetCollection, java.lang.String assetHandlingSet, java.lang.String permissionTemplate, java.util.EnumSet<CatalogingFlag> catalogingFlags, java.util.Set<java.lang.Integer> assignCategoryIDs, CatalogingListener<ItemCollection> catalogingListener) Catalog a collection of assets to this collection.
void	ItemCollection.removeCatalogingListener(CatalogingListener<ItemCollection> catalogingListener) Remove a listener previously added using addCatalogingListener(com.canto.cumulus.events.CatalogingListener)
void	ItemCollection.removeCollectionListener(CollectionListener<ItemCollection> listener) Remove a listener previously added with the call to addCollectionListener(com.canto.cumulus.events.CollectionListener)
static void	ItemCollection.removeGlobalCatalogingListener(CatalogingListener<ItemCollection> catalogingListener) Remove a listener previously added using addGlobalCatalogingListener(com.canto.cumulus.events.CatalogingListener).
static void	ItemCollection.removeGlobalCollectionListener(CollectionListener<ItemCollection> listener) Remove a listener previously added using addGlobalCollectionListener(com.canto.cumulus.events.CollectionListener).
java.util.Set<java.lang.Integer>	Item.update(java.lang.String assetHandlingSet, java.lang.String permissionTemplate, boolean always, boolean includingSubAssets, boolean removeDeletedSubAssetItems, CatalogingListener<ItemCollection> catalogingListener) Update this item according to changes made to the referenced asset.
java.util.Set<java.lang.Integer>	Item.update(java.lang.String assetHandlingSet, java.lang.String permissionTemplate, boolean always, boolean includingSubAssets, boolean removeDeletedSubAssetItems, java.util.Set<GUID> fieldsToUpdate, CatalogingListener<ItemCollection> catalogingListener) Update this item according to changes made to the referenced asset.
java.util.Set<java.lang.Integer>	ItemCollection.updateItems(java.util.Set<java.lang.Integer> itemIDs, java.lang.String assetHandlingSet, java.lang.String permissionTemplate, boolean always, boolean includingSubAssets, boolean removeDeletedSubAssetItems, CatalogingListener<ItemCollection> catalogingListener) Update a set of items in the collection according to changes made to their referenced asset.
java.util.Set<java.lang.Integer>	ItemCollection.updateItems(java.util.Set<java.lang.Integer> itemIDs, java.lang.String assetHandlingSet, java.lang.String permissionTemplate, boolean always, boolean includingSubAssets, boolean removeDeletedSubAssetItems, java.util.Set<GUID> fieldsToUpdate, CatalogingListener<ItemCollection> catalogingListener) Update a set of items in the collection according to changes made to their referenced asset.

Uses of ItemCollection in com.canto.cumulus.db.permissions

Methods in com.canto.cumulus.db.permissions with parameters of type ItemCollection

Modifier and Type	Method and Description
PermissionsList	PermissionManager.getPermissionsList(ItemCollection itemCollection, java.util.Set<ItemIdentifier> idList) Returns a permissions list for a number of records.

Uses of ItemCollection in com.canto.cumulus.db.subscriptions

Methods in com.canto.cumulus.db.subscriptions with parameters of type ItemCollection

Modifier and Type	Method and Description
void	SubscriptionManager.getUserSubscriptions(ItemCollection itemCollection) Replaces the content of the given collection with the items the current user is subscribed to.

Uses of ItemCollection in com.canto.cumulus.fieldvalue

Methods in com.canto.cumulus.fieldvalue that return ItemCollection

Modifier and Type	Method and Description
ItemCollection	VocabularyFieldValue.findItems(java.lang.String searchValue, boolean searchEqual, int languageID) Returns an ItemCollection containing the items of the $Vocabulary catalog matching the defined query (see @link FieldDefinition#getVocabularyQuery) and the searchValue.

Methods in com.canto.cumulus.fieldvalue with parameters of type ItemCollection

Modifier and Type	Method and Description
static void	VocabularyFieldValue.findItems(java.lang.String searchValue, boolean searchEqual, int languageID, java.util.Set<java.lang.Integer> itemIDsToIgnore, ItemCollection vocabularyItemCollection) Searches for items of the $Vocabulary catalog matching the defined query (see @link FieldDefinition#getVocabularyQuery) and the searchValue.

Uses of ItemCollection in com.canto.cumulus.utils

Methods in com.canto.cumulus.utils with parameters of type ItemCollection

Modifier and Type	Method and Description
static void	MetadataExchange.exportItems(ItemCollection itemCollection, java.util.List<java.lang.Integer> itemIDs, java.io.OutputStream destination, MetadataExchange.Format format, MetadataExchange.FieldFilter fieldFilter, MetadataExchange.ProgressListener progress) Exports all items or the items with the specified IDs from the given ItemCollection into the output stream.
static void	MetadataExchange.importItems(java.io.InputStream source, long sourceLength, java.lang.String permissionTemplate, ItemCollection destination, MetadataExchange.Format format, MetadataExchange.FieldFilter fieldFilter, MetadataExchange.ProgressListener progress) Imports the given stream into new records.