com.canto.cumulus

Class RecordItem

java.lang.Object

com.canto.cumulus.Item

com.canto.cumulus.RecordItem

public class RecordItem
extends Item

This class represents a record in the Cumulus.TABLE_NAME_ASSET_RECORDS table of a Cumulus catalog.

Since:

8.0

Method Summary

Methods

Modifier and Type	Method and Description
CategoriesFieldValue	getCategoriesValue() Get the value of the field "Categories" which stores the IDs of the categories that this record item is assigned to.
java.util.Set<java.lang.String>	getCollections(boolean searchSharedCollections, boolean searchUserCollections, java.util.EnumSet<CollectionType> acceptedTypes) Find all collections that this record item is part of and return their names.
RecordItemCollection	getRecordItemCollection() Return the collection object that this record item comes from.
void	setCategoriesValue(CategoriesFieldValue categoriesValue) Modify the category assignment of this record item.
java.lang.String	toString() Return a string representation of this record item.

Methods inherited from class com.canto.cumulus.Item

applyPermissionTemplate, checkin, checkin, checkout, clearModifiedValue, clearValue, convertAsset, copyAsset, deleteItem, deleteItem, deleteItem, doAssetAction, doAssetAction, doAssetAction, equals, getAssetReferenceValue, getAssetXRefValue, getBinaryValue, getBooleanValue, getCatalogID, getCumulusSession, getDataSizeValue, getDateOnlyValue, getDateValue, getDisplayString, getDisplayString, getDisplayString, getDoubleValue, getID, getIntValue, getItemCollection, getItemIdentifier, getLabelValue, getLengthInInchValue, getLongValue, getPictureValue, getRatingValue, getResolutionValue, getStringEnumValue, getStringValue, getStringValue, getTableValue, getTimeOnlyValue, getUserUIDValue, getVocabularyValue, hashCode, hasValue, isCheckedOut, logUsage, matchesQuery, moveAsset, renameAsset, rollback, save, save, setAssetReferenceValue, setAssetXRefValue, setBinaryValue, setBooleanValue, setDataSizeValue, setDateOnlyValue, setDateValue, setDoubleValue, setIntValue, setLabelValue, setLengthInInchValue, setLongValue, setPictureValue, setRatingValue, setResolutionValue, setStringEnumValue, setStringValue, setTimeOnlyValue, setVocabularyValue, undoCheckout, update, update, updateAsset, updateAssetReference, updateAssetReference, updateFormulaFields, validate

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getRecordItemCollection

public RecordItemCollection getRecordItemCollection()

Return the collection object that this record item comes from.

Returns:

The collection that this record item comes from.

getCategoriesValue

public CategoriesFieldValue getCategoriesValue()
                                        throws CumulusException

Get the value of the field "Categories" which stores the IDs of the categories that this record item is assigned to.

Returns:

A field value wrapper object for the categories assigned to this record item.

Throws:

CumulusException - on error.

setCategoriesValue

public void setCategoriesValue(CategoriesFieldValue categoriesValue)
                        throws CumulusException

Modify the category assignment of this record item. You need to call Item.save() to store the changes made to this record item in the catalog. You can pass the field value wrapper object of another record item here but it has to come from the same catalog.

Parameters:

categoriesValue - The field value wrapper containing the assigned categories.

Throws:

CumulusException - on error

getCollections

public java.util.Set<java.lang.String> getCollections(boolean searchSharedCollections,
                                             boolean searchUserCollections,
                                             java.util.EnumSet<CollectionType> acceptedTypes)

Find all collections that this record item is part of and return their names.

Parameters:

searchSharedCollections - search in shared collections

searchUserCollections - search in the current user's private collections

Returns:

A set of names of collections this record item is part of.

Since:

9.1

toString

public java.lang.String toString()

Return a string representation of this record item. Tis method returns the contents of the field "Record Name", "Asset Name" or a string containing the record item ID.

Overrides:

toString in class Item

Returns:

The string representation of this record item.