com.canto.cumulus

Class MultiRecordItemCollection

java.lang.Object

com.canto.cumulus.MultiItemCollection

com.canto.cumulus.MultiRecordItemCollection

All Implemented Interfaces:

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

public class MultiRecordItemCollection
extends MultiItemCollection

A collection of RecordItemCollection objects for different catalogs. You can create a new instance using Server.newMultiRecordItemCollection().

Since:

8.0

Method Summary

Methods

Modifier and Type	Method and Description
MultiRecordItemCollection	clone(boolean createEmptyClone) Create a clone of this collection.
MultiRecordItemCollection	clone(boolean createEmptyClone, boolean createNewCollection) Create a clone of this collection.
void	find(java.util.Map<java.lang.Integer,java.util.Set<java.lang.Integer>> categoryIDs, java.util.EnumSet<FindFlag> flags, CombineMode combine) Find record items using the categories assigned to them.
void	find(java.util.Map<java.lang.Integer,java.util.Set<java.lang.Integer>> categoryIDs, java.util.EnumSet<FindFlag> flags, CombineMode combine, boolean logSearchStatistic) Find record items using the categories assigned to them.
java.lang.String	getMasterAssetsOnlyQuery() Return a query string that find only master assets.
RecordItem	getRecordItemByID(int catalogID, int recordID) Return a record item specified by catalog ID and item ID.
RecordItem	getRecordItemByID(ItemIdentifier itemIdentifier) Return a record item specified by identifier.
RecordItemCollection	getRecordItemCollection(int catalogID) Return the contained RecordItemCollection for the given catalog ID.
JPack	save(java.lang.String collectionSetName, boolean sharedSet, CollectionType type) Save the contents of this collection at the Cumulus server.
JPack	save(java.lang.String collectionSetName, CollectionType type, java.util.Date expirationDate) Save the contents of this collection as a shared collection at the Cumulus server.

Methods inherited from class com.canto.cumulus.MultiItemCollection

addCollectionListener, addFilter, addFilter, addFilter, addFilter, addFilter, addGlobalCollectionListener, addItem, addItem, addItemCollection, addItems, close, doAssetAction, doAssetAction, doAssetAction, equals, find, find, find, find, find, find, find, find, findAll, findAll, getCatalogIDs, getCumulusSession, getDailyStatistics, getDailyStatistics, getItemByID, getItemByID, getItemCollection, getItemCount, getItemFieldStatistics, getItemFieldsWithStatistics, getItemFieldsWithStatistics, getItemFieldsWithStatistics, getItemFieldValues, getItemIDs, getItemPosition, getItemPosition, getItemTotalCount, getMultiLayout, getMultiSorting, getServer, getSortDirection, getSorting, getTableName, hashCode, hasItem, iterator, matchIDs, moveItem, quickSearch, removeAllItems, removeCollectionListener, removeFilter, removeGlobalCollectionListener, removeItem, removeItem, removeItemCollection, removeItems, setFreesorted, setMultiSorting, setSortDirection, setSorting, updateWantedFields, updateWantedFields

Methods inherited from class java.lang.Object

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

Method Detail

clone

public MultiRecordItemCollection clone(boolean createEmptyClone)

Create a clone of this collection. The cloned collection will either be empty or contain the same RecordItemCollections and items as this collection.

Overrides:

clone in class MultiItemCollection

Parameters:

createEmptyClone - Pass true if you want the new collection to be empty. Pass false if it should contain the same items as this collection.

Returns:

The newly created clone of this collection.

clone

public MultiRecordItemCollection clone(boolean createEmptyClone,
                              boolean createNewCollection)

Create a clone of this collection. The cloned collection will either be empty or contain the same RecordItemCollections and items as this collection.

Overrides:

clone in class MultiItemCollection

Parameters:

createEmptyClone - Pass true if you want the new collection to be empty. Pass false if it should contain the same items as this collection.

createNewCollection - Pass true if you want the new collection has no specific filters and sorting settings. Pass false if you want the new collection to have the same filters and sorting settings as this collection.

Returns:

The newly created clone of this collection.

Since:

9.2.4

getRecordItemByID

public RecordItem getRecordItemByID(ItemIdentifier itemIdentifier)
                             throws ItemNotFoundException,
                                    CumulusException

Return a record item specified by identifier.

Parameters:

itemIdentifier - The identifier of the record item to be returned.

Returns:

The RecordItem object for the given identifier.

Throws:

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

CumulusException - on other errors.

getRecordItemByID

public RecordItem getRecordItemByID(int catalogID,
                           int recordID)
                             throws ItemNotFoundException,
                                    CumulusException

Return a record item specified by catalog ID and item ID. This method overwrites the base class method by returning a RecordItem instance instead of an Item instance. This method returns the same result as MultiItemCollection.getItemByID(int, int) but is declared to return a RecordItem.

Parameters:

catalogID - The ID of the item's catalog to be returned.

recordID - The ID of the record item to be returned.

Returns:

The RecordItem object for the given catalog ID and item ID.

Throws:

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

CumulusException - on other errors.

getRecordItemCollection

public RecordItemCollection getRecordItemCollection(int catalogID)
                                             throws InvalidArgumentException,
                                                    CumulusException

Return the contained RecordItemCollection for the given catalog ID. This method overwrites the base class method by returning a RecordItemCollection instance instead of an ItemCollection instance. This method returns the same result as MultiItemCollection.getItemCollection(int) but is declared to return a RecordItemCollection.

Parameters:

catalogID - The catalog ID of the collection to be returned.

Returns:

The RecordItemCollection contained in this collection that comes from the given catalog.

Throws:

InvalidArgumentException - if the catalog ID is not valid

CumulusException - on other errors

See Also:

MultiItemCollection.addItemCollection(ItemCollection), MultiItemCollection.getItemCollection(int)

find

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

Find record items using the categories assigned to them.

Parameters:

categoryIDs - A map using the catalog ID as key and a set of category IDs per catalog as value. These are the categories to match.

flags - options that determine how to use the categories for searching. Either specify null or FindFlag.SEARCH_CATEGORIES_USE_USER_SETTINGS to use te current user's setting for these options or specify individual flags such as FindFlag.SEARCH_CATEGORIES_ABOVE, FindFlag.SEARCH_CATEGORIES_BELOW, FindFlag.SEARCH_CATEGORIES_EXACT, FindFlag.SEARCH_CATEGORIES_MATCH_ONE, or FindFlag.SEARCH_CATEGORIES_RESOLVE_RELATED.

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.

Throws:

CumulusException - on errors (e.g. wrong catalog ID or category ID)

find

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

Find record items using the categories assigned to them.

Parameters:

categoryIDs - A map using the catalog ID as key and a set of category IDs per catalog as value. These are the categories to match.

flags - options that determine how to use the categories for searching. Either specify null or FindFlag.SEARCH_CATEGORIES_USE_USER_SETTINGS to use te current user's setting for these options or specify individual flags such as FindFlag.SEARCH_CATEGORIES_ABOVE, FindFlag.SEARCH_CATEGORIES_BELOW, FindFlag.SEARCH_CATEGORIES_EXACT, FindFlag.SEARCH_CATEGORIES_MATCH_ONE, or FindFlag.SEARCH_CATEGORIES_RESOLVE_RELATED.

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

Throws:

CumulusException - on errors (e.g. wrong catalog ID or category ID)

Since:

10.2

save

public JPack save(java.lang.String collectionSetName,
         boolean sharedSet,
         CollectionType type)
           throws PermissionDeniedException,
                  CumulusException

Save the contents of this collection at the Cumulus server.

Parameters:

collectionSetName - The name of the collection at the server.

sharedSet - Pass true to make the collection shared among users, false if you want to allow access only to the current user.

type - The type of collection to create. Typically you create a CollectionType.NORMAL_COLLECTION. The other types are used internally and serve a special purpose.

Returns:

The package containing the additional collection information such as layout information for the client. This is used internally and should not be saved by third-party code.

Throws:

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

CumulusException - on other errors.

save

public JPack save(java.lang.String collectionSetName,
         CollectionType type,
         java.util.Date expirationDate)
           throws PermissionDeniedException,
                  CumulusException

Save the contents of this collection as a shared collection at the Cumulus server.

Parameters:

collectionSetName - The name of the collection at the server.

type - The type of collection to create. Typically you create a CollectionType.NORMAL_COLLECTION. The other types are used internally and serve a special purpose.

expirationDate - The date when the created collection should be deleted automatically at the cumulus server.

Returns:

The package containing the additional collection information such as layout information for the client. This is used internally and should not be saved by third-party code.

Throws:

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

CumulusException - on other errors.

Since:

8.1

getMasterAssetsOnlyQuery

public java.lang.String getMasterAssetsOnlyQuery()

Return a query string that find only master assets. A master asset is an asset hat is not contained in another, is not a variant of another or an alternate of another. The resulting query can be used to find

Returns:

A query string which finds only master assets.

Since:

10.0.1