com.canto.cumulus

Class RecordItemCollection

java.lang.Object

com.canto.cumulus.ItemCollection

com.canto.cumulus.RecordItemCollection

All Implemented Interfaces:

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

public class RecordItemCollection
extends ItemCollection

A collection of RecordItem objects of a Cumulus catalog. Every time you get an ItemCollection for the table Cumulus.TABLE_NAME_ASSET_RECORDS the CumulusJavaClasses will return an instance of this class. Most of the functionality is available through methods of the base class except for the category assignment which is added functionality for asset records.

Since:

8.0

Method Summary

Methods

Modifier and Type	Method and Description
RecordItemCollection	clone() Create a clone of this collection.
Item	createItem() Create a new RecordItem object.
Item	createItem(java.lang.String permissionTemplate) Create a new RecordItem object.
RecordItem	createRecordItem() Create a new RecordItem object.
RecordItem	createRecordItem(java.lang.String permissionTemplate) Create a new RecordItem object.
int	find(java.util.Set<java.lang.Integer> categoryIDs, java.util.EnumSet<FindFlag> flags, CombineMode combine) Find record items using assigned categories.
int	find(java.util.Set<java.lang.Integer> categoryIDs, java.util.EnumSet<FindFlag> flags, CombineMode combine, boolean logSearchStatistic) Find record items using assigned categories.
Item	getItemByID(int itemID) Return a RecordItem specified by ID.
RecordItem	getRecordItemByID(int recordID) Return a RecordItem specified by ID.

Methods inherited from class com.canto.cumulus.ItemCollection

addCatalogingListener, addCollectionListener, addFilter, addFilter, addGlobalCatalogingListener, addGlobalCollectionListener, addItemByID, addItemsByID, catalogAsset, catalogAsset, catalogAsset, catalogAssets, catalogAssets, catalogAssets, close, equals, find, find, find, find, findAll, getCatalog, getCumulusSession, getItemCount, getItemIDs, getItemPosition, getItemTotalCount, getLayout, getMultiSorting, getSortDirection, getSorting, getTableName, hashCode, hasItem, iterator, 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

clone

public RecordItemCollection clone()

Description copied from class: ItemCollection

Create a clone of this collection. The cloned collection will contain the same items as this collection.

Overrides:

clone in class ItemCollection

Returns:

The newly created clone of this collection.

createItem

public Item createItem()
                throws PermissionDeniedException,
                       CumulusException

Create a new RecordItem object. The item returned is not yet saved to the catalog. You need to set some field values of the Item object and then call the Item.save() method to save the

Overrides:

createItem in class ItemCollection

Returns:

The newly created item.

Throws:

PermissionDeniedException - if the current user does not have the necessary permissions for this operation.

CumulusException - on other errors.

See Also:

Item.save()

createItem

public Item createItem(java.lang.String permissionTemplate)
                throws PermissionDeniedException,
                       CumulusException

Create a new RecordItem object. The item returned is not yet saved to the catalog. You need to set some field values of the Item object and then call the Item.save() method to save the

Overrides:

createItem in class ItemCollection

Parameters:

permissionTemplate - the permission template to apply to the new item

Returns:

The newly created item.

Throws:

PermissionDeniedException - if the current user does not have the necessary permissions for this operation.

CumulusException - on other errors.

Since:

8.5

See Also:

Item.save()

createRecordItem

public RecordItem createRecordItem()
                            throws PermissionDeniedException,
                                   CumulusException

Create a new RecordItem object. The item returned is not yet saved to the catalog. You need to set some field values of the Item object and then call the Item.save() method to save the

Returns:

The newly created RecordItem.

Throws:

PermissionDeniedException - if the current user does not have the necessary permissions for this operation.

CumulusException - on other errors.

See Also:

Item.save()

createRecordItem

public RecordItem createRecordItem(java.lang.String permissionTemplate)
                            throws PermissionDeniedException,
                                   CumulusException

Create a new RecordItem object. The item returned is not yet saved to the catalog. You need to set some field values of the Item object and then call the Item.save() method to save the

Parameters:

permissionTemplate - the permission template to apply to the new item

Returns:

The newly created RecordItem.

Throws:

PermissionDeniedException - if the current user does not have the necessary permissions for this operation.

CumulusException - on other errors.

See Also:

Item.save()

getItemByID

public Item getItemByID(int itemID)
                 throws ItemNotFoundException,
                        CumulusException

Return a RecordItem specified by ID.

Overrides:

getItemByID in class ItemCollection

Parameters:

itemID - The ID of the item to be returned.

Returns:

The Item object for the given item.

Throws:

ItemNotFoundException - if the collection does not contain the given item.

CumulusException - on other errors.

See Also:

ItemCollection.hasItem(int), ItemCollection.addItemByID(int), ItemCollection.addItemsByID(java.util.List)

getRecordItemByID

public RecordItem getRecordItemByID(int recordID)
                             throws ItemNotFoundException,
                                    CumulusException

Return a RecordItem specified by ID.

Parameters:

recordID - The ID of the item to be returned.

Returns:

The RecordItem object for the given item.

Throws:

ItemNotFoundException - if the collection does not contain the given item.

CumulusException - on other errors.

See Also:

ItemCollection.hasItem(int), ItemCollection.addItemByID(int), ItemCollection.addItemsByID(java.util.List)

find

public int find(java.util.Set<java.lang.Integer> categoryIDs,
       java.util.EnumSet<FindFlag> flags,
       CombineMode combine)
         throws CumulusException

Find record items using assigned categories.

Parameters:

categoryIDs - The IDs of the categories to search by.

flags - The flags that control the way the categories are searched.

combine - specifies how to combine the result of this search with the existing contents of the collection.:

• CombineMode.FIND_NEW: the search replaces the current contents of the collection.
• CombineMode.FIND_NARROW: the search result will only leave the items in the collection that match the query.
• CombineMode.FIND_BROADEN: the search result will be added to the current collection contents.

Returns:

The number of items in the collection after the search.

Throws:

CumulusException - on error

find

public int find(java.util.Set<java.lang.Integer> categoryIDs,
       java.util.EnumSet<FindFlag> flags,
       CombineMode combine,
       boolean logSearchStatistic)
         throws CumulusException

Find record items using assigned categories.

Parameters:

categoryIDs - The IDs of the categories to search by.

flags - The flags that control the way the categories are searched.

combine - specifies how to combine the result of this search with the existing contents of the collection.:

• CombineMode.FIND_NEW: the search replaces the current contents of the collection.
• CombineMode.FIND_NARROW: the search result will only leave the items in the collection that match the query.
• CombineMode.FIND_BROADEN: the search result will be added to the current collection contents.

logSearchStatistic - specifies whether the query result has to be logged in the search statistic

Returns:

The number of items in the collection after the search.

Throws:

CumulusException - on error

Since:

10.2