AssetHandlingSet (Cumulus Java Classes Documentation)

java.lang.Object
- com.canto.cumulus.prefs.BaseManager
- - com.canto.cumulus.prefs.AssetHandlingSet

All Implemented Interfaces:

Item
```
public class AssetHandlingSet
extends BaseManager
implements Item
```
This class represents an asset handling set.

Nested Class Summary
- Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager
  BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ADD_AND_UPDATE_OPTION_ADD_AND_UPDATE`
`static int`	`ADD_AND_UPDATE_OPTION_ADD_ONLY`
`static int`	`ADD_AND_UPDATE_OPTION_UPDATE_ONLY`
`static int`	`ADD_OR_IGNORE_DUPLICATES_OPTION_ADD`
`static int`	`ADD_OR_IGNORE_DUPLICATES_OPTION_IGNORE`
`static int`	`CENTRAL_ASSET_LOCATION_OPTION_COPY_OR_MOVE`
`static int`	`CENTRAL_ASSET_LOCATION_OPTION_REFERENCE_ORIGINAL`
`static int`	`CREATE_THUMBNAIL_FROM_OPTION_USE_EMBEDDED_THUMBNAIL_IF_AVAILABLE`
`static int`	`CREATE_THUMBNAIL_FROM_OPTION_USE_EMBEDDED_THUMBNAIL_IF_LARGE_ENOUGH`
`static int`	`CREATE_THUMBNAIL_FROM_OPTION_USE_ENTIRE_ASSET`
`static int[]`	`dataKeys`
`static int`	`RESOLVE_OR_IGNORE_OPTION_IGNORE`
`static int`	`RESOLVE_OR_IGNORE_OPTION_RESOLVE`
`static int`	`THUMBNAIL_QUALITY_COLOR_OPTION_HIGH`
`static int`	`THUMBNAIL_QUALITY_COLOR_OPTION_NORMAL`
`static int`	`THUMBNAIL_QUALITY_GRAYSCALE_OPTION_HIGH`
`static int`	`THUMBNAIL_QUALITY_GRAYSCALE_OPTION_NORMAL`
`static int`	`THUMBNAIL_QUALITY_LINEART_OPTION_HIGH`
`static int`	`THUMBNAIL_QUALITY_LINEART_OPTION_NORMAL`
`static int`	`THUMBNAIL_SIZE_OPTION_CUSTOM`
`static int`	`THUMBNAIL_SIZE_OPTION_LARGE`
`static int`	`THUMBNAIL_SIZE_OPTION_MEDIUM`
`static int`	`THUMBNAIL_SIZE_OPTION_SMALL`
`static int`	`THUMBNAIL_SIZE_OTHER` Internal field.
`static int`	`VERSIONING_DELETE_BEHAVIOUR_OPTION_ALWAYS_DELETE_ALL_VERSIONS`
`static int`	`VERSIONING_DELETE_BEHAVIOUR_OPTION_ASK_FOR_VERSION`
`static int`	`VERSIONING_GET_BEHAVIOUR_OPTION_ALWAYS_GET_LATEST_VERSION`
`static int`	`VERSIONING_GET_BEHAVIOUR_OPTION_ASK_FOR_VERSION`
`static int`	`WRITEBACK_METADATA_TO_ASSET_OPTION_ALWAYS`
`static int`	`WRITEBACK_METADATA_TO_ASSET_OPTION_NEVER`
`static int`	`WRITEBACK_METADATA_TO_ASSET_OPTION_SILENTLY`
`static int`	`WRITEBACK_METADATA_WRITE_DESTINATION_OPTION_TO_ASSET_AND_METADATA`
`static int`	`WRITEBACK_METADATA_WRITE_DESTINATION_OPTION_TO_METADATA`

Fields inherited from class com.canto.cumulus.prefs.BaseManager
TYPE_EJP, TYPE_NATIVE

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`copySubAssetsToCentralLocation()` Returns true if the sub assets should also be copied to the central asset location configured for the catalog when cataloging using this asset handling set.
`boolean`	`deleteOriginalAssetAfterCopyToCentralAssetLocation()` Returns true if the original asset should be locally deleted after copying it to the central asset location configured for the catalog when cataloging using this asset handling set.
`JPack`	`exportSet()` Exports this set into a `JPack`.
`int`	`getAddAndUpdate()` Returns the cataloging mode for adding and updating existing records when cataloging using this asset handling set.
`int`	`getAddOrIgnoreDuplicates()` Returns the cataloging mode for adding or ignoring duplicate assets when cataloging using this asset handling set.
`AssetFiltersList`	`getAssetFiltersList()` Returns the list of filters of this asset handling set.
`AssetFormatsList`	`getAssetFormatsList()` Returns the asset formats list of this asset handling set.
`AssetModuleList`	`getAssetGeneralPurposeModuleList()` Returns a list of general purpose asset modules of this asset handling set.
`AssetModuleList`	`getAssetMetadataBridgesModuleList()` Returns a list of asset metadata bridge modules of this asset handling set.
`AssetModuleList`	`getAssetProcessorModuleList()` Returns a list of asset processor modules of this asset handling set.
`AssetModuleList`	`getAssetStorageModuleList()` Returns a list of asset storage modules of this asset handling set.
`boolean`	`getAutoAddNewFormats()` Returns whether newly found formats should automatically be added to the formats list.
`boolean`	`getCatalogMissingReferencedAssets()` Returns whether missing referenced assets should also be cataloged.
`boolean`	`getCatalogUnknownFormats()` Returns whether unknown formats should be cataloged as well.
`int`	`getCentralAssetLocation()` Returns the mode for handling the central asset location configured for the catalog when cataloging using this asset handling set.
`int`	`getCreateThumbnailFrom()` Returns the thumbnail source when cataloging using this asset handling set.
`java.lang.String`	`getDescription(int languageID)` Returns the description for the given language id.
`java.lang.String`	`getDisplayName(int languageID, boolean fallbackToDefaultName)` Returns the display name for the given language id.
`java.lang.String`	`getID()` Returns the UID of the item in the items namespace.
`boolean`	`getIsDefault()` Returns whether this asset handling set is the default asset handling set.
`java.lang.String`	`getMetadataTemplate()` Returns the name of the metadata template applied when cataloging or null when not configured.
`ModulePreferencesList`	`getModulePreferencesList()` Returns the manager for module preferences.
`java.lang.String`	`getName()` Returns the name of this asset handling set.
`boolean`	`getOptimizeThumbnail()` Returns whether thumbnails should be optimized on creation.
`java.lang.String`	`getPreFillerRecordViewSet()` Returns the name of the record view set to use when showing the PreFiller or null when not configured.
`int`	`getResolveOrIgnore()` Returns whether linked assets should be resolved.
`RestrictionsList`	`getRestrictionsList()` Returns the list of roles and users that are allowed to view this set.
`int`	`getThumbnailQualityColor()` Returns the mode for thumbnail quality for color when cataloging using this asset handling set.
`int`	`getThumbnailQualityGrayscale()` Returns the mode for thumbnail quality for grayscale when cataloging using this asset handling set.
`int`	`getThumbnailQualityLineArt()` Returns the mode for thumbnail quality for lineart when cataloging using this asset handling set.
`int`	`getThumbnailSize()` Returns the thumbnail size when cataloging using this asset handling set.
`int`	`getThumbnailSizeOther()` Returns the custom thumbnail size.
`boolean`	`getUpdateAssetModificationDateWhenWritingMetadata()` Returns whether the assets modification date should be updated when writing back metadata to that asset.
`int`	`getVersioningGLVBehaviour()` Returns the mode for handling the getting of assets when using this asset handling set.
`AssetHandlingSetWorkflowList`	`getWorkflowList()` Returns the list of referenced workflows which should be started when cataloging with this asset handling set.
`int`	`getWriteMDToAssets()` Returns the mode for writing metadata back to the asset when using this asset handling set.
`int`	`getWriteMetadataDestination()` Returns the destination for writing metadata back.
`boolean`	`isDefault()` Returns whether this item is the default item.
`boolean`	`isSharingRestricted()` Returns whether the set visibility is restricted to a group of users or roles.
`void`	`setAddAndUpdate(int value)` Sets the cataloging mode for adding and updating existing records when cataloging using this asset handling set.
`void`	`setAddOrIgnoreDuplicates(int value)` Sets the cataloging mode for adding or ignoring duplicate assets when cataloging using this asset handling set.
`void`	`setAutoAddNewFormats(boolean value)` Sets whether newly found formats should automatically be added to the formats list.
`void`	`setCatalogMissingReferencedAssets(boolean value)` Sets whether missing referenced assets should also be cataloged.
`void`	`setCatalogUnknownFormats(boolean value)` Configures whether unknown formats should be cataloged as well.
`void`	`setCentralAssetLocation(int cal)` Sets the mode for handling the central asset location configured for the catalog when cataloging using this asset handling set.
`void`	`setCopySubAssetsToCentralLocation(boolean value)` Configures whether the sub assets should also be copied to the central asset location configured for the catalog when cataloging using this asset handling set.
`void`	`setCreateThumbnailFrom(int value)` Sets the thumbnail source when cataloging using this asset handling set.
`void`	`setDeleteOriginalAssetAfterCopyToCentralAssetLocation(boolean value)` Configures whether the original asset should be locally deleted after copying it to the central asset location configured for the catalog when cataloging using this asset handling set.
`void`	`setDescription(int languageID, java.lang.String description)` Sets the description for the given language.
`void`	`setDisplayName(int languageID, java.lang.String displayName)` Sets the display name for the given language.
`void`	`setMetadataTemplate(java.lang.String value)` Sets the name of the metadata template applied when cataloging or null when not configured.
`void`	`setOptimizeThumbnail(boolean optimize)` Sets whether thumbnails should be optimized on creation.
`void`	`setPreFillerRecordViewSet(java.lang.String value)` Sets the name of the record view set being used when showing the PreFiller.
`void`	`setResolveOrIgnore(int val)` Configures whether linked assets should be resolved.
`void`	`setSharingRestricted(boolean value)` Sets whether the set visibility is restricted to a group of users or roles.
`void`	`setThumbnailQualityColor(int quality)` Sets the mode for thumbnail quality for color when cataloging using this asset handling set.
`void`	`setThumbnailQualityGrayscale(int quality)` Sets the mode for thumbnail quality for grayscale when cataloging using this asset handling set.
`void`	`setThumbnailQualityLineArt(int quality)` Sets the mode for thumbnail quality for lineart when cataloging using this asset handling set.
`void`	`setThumbnailSize(int value)` Sets the thumbnail size when cataloging using this asset handling set.
`void`	`setThumbnailSizeOther(int value)` Sets the custom thumbnail size.
`void`	`setUpdateAssetModificationDateWhenWritingMetadata(boolean update)` Configures whether the assets modification date should be updated when writing back metadata to that asset.
`void`	`setUseMetadataTemplate(boolean value)` Set whether a metadata template should automatically be applied when cataloging.
`void`	`setUsePreFillerForNewRecords(boolean value)` Sets whether the metadata editor window should be shown for new records before saving the record.
`void`	`setUsePreFillerForUpdatedRecords(boolean value)` Sets whether the metadata editor window should be shown for updated records before saving the record.
`void`	`setVersioningGLVBehaviour(int value)` Sets the mode for handling the getting of assets when using this asset handling set.
`void`	`setWriteMDToAssets(int value)` Sets the mode for writing metadata back to the asset when using this asset handling set.
`void`	`setWriteMetadataDestination(int mode)` Sets the destination for writing metadata back.
`boolean`	`useMetadataEditorForNewRecords()` Returns whether the metadata editor window should be shown for new records before saving the record.
`boolean`	`useMetadataEditorForUpdatedRecords()` Returns whether the metadata editor window should be shown for updated records before saving the record.
`boolean`	`useMetadataTemplate()` Returns whether a metadata template should automatically be applied when cataloging.

Methods inherited from class com.canto.cumulus.prefs.BaseManager
addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, getPack, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, save, toString, writeAsXML

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CREATE_THUMBNAIL_FROM_OPTION_USE_EMBEDDED_THUMBNAIL_IF_AVAILABLE
```
public static final int CREATE_THUMBNAIL_FROM_OPTION_USE_EMBEDDED_THUMBNAIL_IF_AVAILABLE
```
    See Also:
    Constant Field Values
  - CREATE_THUMBNAIL_FROM_OPTION_USE_EMBEDDED_THUMBNAIL_IF_LARGE_ENOUGH
```
public static final int CREATE_THUMBNAIL_FROM_OPTION_USE_EMBEDDED_THUMBNAIL_IF_LARGE_ENOUGH
```
    See Also:
    Constant Field Values
  - CREATE_THUMBNAIL_FROM_OPTION_USE_ENTIRE_ASSET
```
public static final int CREATE_THUMBNAIL_FROM_OPTION_USE_ENTIRE_ASSET
```
    See Also:
    Constant Field Values
  - THUMBNAIL_SIZE_OPTION_SMALL
```
public static final int THUMBNAIL_SIZE_OPTION_SMALL
```
    See Also:
    Constant Field Values
  - THUMBNAIL_SIZE_OPTION_MEDIUM
```
public static final int THUMBNAIL_SIZE_OPTION_MEDIUM
```
    See Also:
    Constant Field Values
  - THUMBNAIL_SIZE_OPTION_LARGE
```
public static final int THUMBNAIL_SIZE_OPTION_LARGE
```
    See Also:
    Constant Field Values
  - THUMBNAIL_SIZE_OPTION_CUSTOM
```
public static final int THUMBNAIL_SIZE_OPTION_CUSTOM
```
    See Also:
    Constant Field Values
  - ADD_AND_UPDATE_OPTION_ADD_ONLY
```
public static final int ADD_AND_UPDATE_OPTION_ADD_ONLY
```
    See Also:
    Constant Field Values
  - ADD_AND_UPDATE_OPTION_ADD_AND_UPDATE
```
public static final int ADD_AND_UPDATE_OPTION_ADD_AND_UPDATE
```
    See Also:
    Constant Field Values
  - ADD_AND_UPDATE_OPTION_UPDATE_ONLY
```
public static final int ADD_AND_UPDATE_OPTION_UPDATE_ONLY
```
    See Also:
    Constant Field Values
  - ADD_OR_IGNORE_DUPLICATES_OPTION_ADD
```
public static final int ADD_OR_IGNORE_DUPLICATES_OPTION_ADD
```
    See Also:
    Constant Field Values
  - ADD_OR_IGNORE_DUPLICATES_OPTION_IGNORE
```
public static final int ADD_OR_IGNORE_DUPLICATES_OPTION_IGNORE
```
    See Also:
    Constant Field Values
  - WRITEBACK_METADATA_TO_ASSET_OPTION_NEVER
```
public static final int WRITEBACK_METADATA_TO_ASSET_OPTION_NEVER
```
    See Also:
    Constant Field Values
  - WRITEBACK_METADATA_TO_ASSET_OPTION_SILENTLY
```
public static final int WRITEBACK_METADATA_TO_ASSET_OPTION_SILENTLY
```
    See Also:
    Constant Field Values
  - WRITEBACK_METADATA_TO_ASSET_OPTION_ALWAYS
```
public static final int WRITEBACK_METADATA_TO_ASSET_OPTION_ALWAYS
```
    See Also:
    Constant Field Values
  - WRITEBACK_METADATA_WRITE_DESTINATION_OPTION_TO_ASSET_AND_METADATA
```
public static final int WRITEBACK_METADATA_WRITE_DESTINATION_OPTION_TO_ASSET_AND_METADATA
```
    See Also:
    Constant Field Values
  - WRITEBACK_METADATA_WRITE_DESTINATION_OPTION_TO_METADATA
```
public static final int WRITEBACK_METADATA_WRITE_DESTINATION_OPTION_TO_METADATA
```
    See Also:
    Constant Field Values
  - THUMBNAIL_QUALITY_LINEART_OPTION_NORMAL
```
public static final int THUMBNAIL_QUALITY_LINEART_OPTION_NORMAL
```
    See Also:
    Constant Field Values
  - THUMBNAIL_QUALITY_LINEART_OPTION_HIGH
```
public static final int THUMBNAIL_QUALITY_LINEART_OPTION_HIGH
```
    See Also:
    Constant Field Values
  - THUMBNAIL_QUALITY_COLOR_OPTION_NORMAL
```
public static final int THUMBNAIL_QUALITY_COLOR_OPTION_NORMAL
```
    See Also:
    Constant Field Values
  - THUMBNAIL_QUALITY_COLOR_OPTION_HIGH
```
public static final int THUMBNAIL_QUALITY_COLOR_OPTION_HIGH
```
    See Also:
    Constant Field Values
  - THUMBNAIL_QUALITY_GRAYSCALE_OPTION_NORMAL
```
public static final int THUMBNAIL_QUALITY_GRAYSCALE_OPTION_NORMAL
```
    See Also:
    Constant Field Values
  - THUMBNAIL_QUALITY_GRAYSCALE_OPTION_HIGH
```
public static final int THUMBNAIL_QUALITY_GRAYSCALE_OPTION_HIGH
```
    See Also:
    Constant Field Values
  - CENTRAL_ASSET_LOCATION_OPTION_COPY_OR_MOVE
```
public static final int CENTRAL_ASSET_LOCATION_OPTION_COPY_OR_MOVE
```
    See Also:
    Constant Field Values
  - CENTRAL_ASSET_LOCATION_OPTION_REFERENCE_ORIGINAL
```
public static final int CENTRAL_ASSET_LOCATION_OPTION_REFERENCE_ORIGINAL
```
    See Also:
    Constant Field Values
  - RESOLVE_OR_IGNORE_OPTION_RESOLVE
```
public static final int RESOLVE_OR_IGNORE_OPTION_RESOLVE
```
    See Also:
    Constant Field Values
  - RESOLVE_OR_IGNORE_OPTION_IGNORE
```
public static final int RESOLVE_OR_IGNORE_OPTION_IGNORE
```
    See Also:
    Constant Field Values
  - VERSIONING_GET_BEHAVIOUR_OPTION_ALWAYS_GET_LATEST_VERSION
```
public static final int VERSIONING_GET_BEHAVIOUR_OPTION_ALWAYS_GET_LATEST_VERSION
```
    See Also:
    Constant Field Values
  - VERSIONING_GET_BEHAVIOUR_OPTION_ASK_FOR_VERSION
```
public static final int VERSIONING_GET_BEHAVIOUR_OPTION_ASK_FOR_VERSION
```
    See Also:
    Constant Field Values
  - VERSIONING_DELETE_BEHAVIOUR_OPTION_ALWAYS_DELETE_ALL_VERSIONS
```
public static final int VERSIONING_DELETE_BEHAVIOUR_OPTION_ALWAYS_DELETE_ALL_VERSIONS
```
    See Also:
    Constant Field Values
  - VERSIONING_DELETE_BEHAVIOUR_OPTION_ASK_FOR_VERSION
```
public static final int VERSIONING_DELETE_BEHAVIOUR_OPTION_ASK_FOR_VERSION
```
    See Also:
    Constant Field Values
  - THUMBNAIL_SIZE_OTHER
```
public static final int THUMBNAIL_SIZE_OTHER
```
    Internal field.
    
    See Also:
    Constant Field Values
  - dataKeys
```
public static final int[] dataKeys
```
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Returns the name of this asset handling set.
    
    Returns:
    name of this asset handling set
  - getCreateThumbnailFrom
```
public int getCreateThumbnailFrom()
```
    Returns the thumbnail source when cataloging using this asset handling set. The possible values are CREATE_THUMBNAIL_FROM_OPTION_USE_EMBEDDED_THUMBNAIL_IF_AVAILABLE, CREATE_THUMBNAIL_FROM_OPTION_USE_EMBEDDED_THUMBNAIL_IF_LARGE_ENOUGH and CREATE_THUMBNAIL_FROM_OPTION_USE_ENTIRE_ASSET. Defaults to CREATE_THUMBNAIL_FROM_OPTION_USE_EMBEDDED_THUMBNAIL_IF_AVAILABLE.
    
    Returns:
    the wanted thumbnail source
  - setCreateThumbnailFrom
```
public void setCreateThumbnailFrom(int value)
```
    Sets the thumbnail source when cataloging using this asset handling set. The possible values are CREATE_THUMBNAIL_FROM_OPTION_USE_EMBEDDED_THUMBNAIL_IF_AVAILABLE, CREATE_THUMBNAIL_FROM_OPTION_USE_EMBEDDED_THUMBNAIL_IF_LARGE_ENOUGH and CREATE_THUMBNAIL_FROM_OPTION_USE_ENTIRE_ASSET.
    
    Parameters:
    value - the wanted thumbnail source
  - getThumbnailSize
```
public int getThumbnailSize()
```
    Returns the thumbnail size when cataloging using this asset handling set. The possible values are THUMBNAIL_SIZE_OPTION_SMALL, THUMBNAIL_SIZE_OPTION_MEDIUM, THUMBNAIL_SIZE_OPTION_LARGE and THUMBNAIL_SIZE_OPTION_CUSTOM. Defaults to THUMBNAIL_SIZE_OPTION_MEDIUM.
    
    Returns:
    the wanted thumbnail size
  - setThumbnailSize
```
public void setThumbnailSize(int value)
```
    Sets the thumbnail size when cataloging using this asset handling set. The possible values are THUMBNAIL_SIZE_OPTION_SMALL, THUMBNAIL_SIZE_OPTION_MEDIUM, THUMBNAIL_SIZE_OPTION_LARGE and THUMBNAIL_SIZE_OPTION_CUSTOM.
    
    Parameters:
    value - the wanted thumbnail size
  - getThumbnailSizeOther
```
public int getThumbnailSizeOther()
```
    Returns the custom thumbnail size. Defaults to 128px.
    
    Returns:
    the custom thumbnail size
  - setThumbnailSizeOther
```
public void setThumbnailSizeOther(int value)
```
    Sets the custom thumbnail size. Values larger than 1024 are ignored.
    
    Parameters:
    value - the new custom thumbnail size.
  - getOptimizeThumbnail
```
public boolean getOptimizeThumbnail()
```
    Returns whether thumbnails should be optimized on creation.
    
    Returns:
    true if thumbnail should be optimized
  - setOptimizeThumbnail
```
public void setOptimizeThumbnail(boolean optimize)
```
    Sets whether thumbnails should be optimized on creation.
    
    Parameters:
    optimize - true if thumbnail should be optimized
  - getAddAndUpdate
```
public int getAddAndUpdate()
```
    Returns the cataloging mode for adding and updating existing records when cataloging using this asset handling set. The possible values are ADD_AND_UPDATE_OPTION_ADD_ONLY, ADD_AND_UPDATE_OPTION_ADD_AND_UPDATE and ADD_AND_UPDATE_OPTION_UPDATE_ONLY. Defaults to ADD_AND_UPDATE_OPTION_ADD_AND_UPDATE.
    
    Returns:
    the wanted mode for adding or updating records
  - setAddAndUpdate
```
public void setAddAndUpdate(int value)
```
    Sets the cataloging mode for adding and updating existing records when cataloging using this asset handling set. The possible values are ADD_AND_UPDATE_OPTION_ADD_ONLY, ADD_AND_UPDATE_OPTION_ADD_AND_UPDATE and ADD_AND_UPDATE_OPTION_UPDATE_ONLY.
    
    Parameters:
    value - the wanted mode for adding or updating records
  - getAddOrIgnoreDuplicates
```
public int getAddOrIgnoreDuplicates()
```
    Returns the cataloging mode for adding or ignoring duplicate assets when cataloging using this asset handling set. The possible values are ADD_OR_IGNORE_DUPLICATES_OPTION_ADD and ADD_OR_IGNORE_DUPLICATES_OPTION_IGNORE. Defaults to ADD_OR_IGNORE_DUPLICATES_OPTION_IGNORE.
    
    Returns:
    the wanted mode for adding or ignoring duplicate assets
  - setAddOrIgnoreDuplicates
```
public void setAddOrIgnoreDuplicates(int value)
```
    Sets the cataloging mode for adding or ignoring duplicate assets when cataloging using this asset handling set. The possible values are ADD_OR_IGNORE_DUPLICATES_OPTION_ADD and ADD_OR_IGNORE_DUPLICATES_OPTION_IGNORE.
    
    Parameters:
    value - the wanted mode for adding or ignoring duplicate assets
  - getWriteMDToAssets
```
public int getWriteMDToAssets()
```
    Returns the mode for writing metadata back to the asset when using this asset handling set. The possible values are WRITEBACK_METADATA_TO_ASSET_OPTION_NEVER, WRITEBACK_METADATA_TO_ASSET_OPTION_SILENTLY and WRITEBACK_METADATA_TO_ASSET_OPTION_ALWAYS. Defaults to WRITEBACK_METADATA_TO_ASSET_OPTION_NEVER.
    
    Returns:
    the wanted mode for writing metadata back to the asset
  - setWriteMDToAssets
```
public void setWriteMDToAssets(int value)
```
    Sets the mode for writing metadata back to the asset when using this asset handling set. The possible values are WRITEBACK_METADATA_TO_ASSET_OPTION_NEVER, WRITEBACK_METADATA_TO_ASSET_OPTION_SILENTLY and WRITEBACK_METADATA_TO_ASSET_OPTION_ALWAYS.
    
    Parameters:
    value - the wanted mode for writing metadata back to the asset
  - getWriteMetadataDestination
```
public int getWriteMetadataDestination()
```
    Returns the destination for writing metadata back. This can be either WRITEBACK_METADATA_WRITE_DESTINATION_OPTION_TO_ASSET_AND_METADATA or WRITEBACK_METADATA_WRITE_DESTINATION_OPTION_TO_METADATA.
    
    Returns:
    the mode for writing metadata back
    Since:
    
    8.5
  - setWriteMetadataDestination
```
public void setWriteMetadataDestination(int mode)
```
    Sets the destination for writing metadata back. This can be either WRITEBACK_METADATA_WRITE_DESTINATION_OPTION_TO_ASSET_AND_METADATA or WRITEBACK_METADATA_WRITE_DESTINATION_OPTION_TO_METADATA.
    
    Parameters:
    mode - the mode for writing metadata back
    Since:
    
    8.5
  - getUpdateAssetModificationDateWhenWritingMetadata
```
public boolean getUpdateAssetModificationDateWhenWritingMetadata()
```
    Returns whether the assets modification date should be updated when writing back metadata to that asset.
    
    Returns:
    true if the modification date should be updated
    Since:
    
    8.1
  - setUpdateAssetModificationDateWhenWritingMetadata
```
public void setUpdateAssetModificationDateWhenWritingMetadata(boolean update)
```
    Configures whether the assets modification date should be updated when writing back metadata to that asset.
    
    Parameters:
    update - true if the modification date should be updated
    Since:
    
    8.1
  - getThumbnailQualityLineArt
```
public int getThumbnailQualityLineArt()
```
    Returns the mode for thumbnail quality for lineart when cataloging using this asset handling set. The possible values are THUMBNAIL_QUALITY_LINEART_OPTION_NORMAL and THUMBNAIL_QUALITY_LINEART_OPTION_HIGH. Defaults to THUMBNAIL_QUALITY_LINEART_OPTION_HIGH.
    
    Returns:
    the mode for thumbnail quality for lineart
  - setThumbnailQualityLineArt
```
public void setThumbnailQualityLineArt(int quality)
```
    Sets the mode for thumbnail quality for lineart when cataloging using this asset handling set. The possible values are THUMBNAIL_QUALITY_LINEART_OPTION_NORMAL and THUMBNAIL_QUALITY_LINEART_OPTION_HIGH.
    
    Parameters:
    quality - the wanted mode for thumbnail quality for lineart
  - getThumbnailQualityGrayscale
```
public int getThumbnailQualityGrayscale()
```
    Returns the mode for thumbnail quality for grayscale when cataloging using this asset handling set. The possible values are THUMBNAIL_QUALITY_GRAYSCALE_OPTION_NORMAL and THUMBNAIL_QUALITY_GRAYSCALE_OPTION_HIGH. Defaults to THUMBNAIL_QUALITY_GRAYSCALE_OPTION_HIGH.
    
    Returns:
    the mode for thumbnail quality for grayscale
  - setThumbnailQualityGrayscale
```
public void setThumbnailQualityGrayscale(int quality)
```
    Sets the mode for thumbnail quality for grayscale when cataloging using this asset handling set. The possible values are THUMBNAIL_QUALITY_GRAYSCALE_OPTION_NORMAL and THUMBNAIL_QUALITY_GRAYSCALE_OPTION_HIGH. Defaults to THUMBNAIL_QUALITY_GRAYSCALE_OPTION_HIGH.
    
    Parameters:
    quality - the wanted mode for thumbnail quality for grayscale
  - getThumbnailQualityColor
```
public int getThumbnailQualityColor()
```
    Returns the mode for thumbnail quality for color when cataloging using this asset handling set. The possible values are THUMBNAIL_QUALITY_COLOR_OPTION_NORMAL and THUMBNAIL_QUALITY_COLOR_OPTION_HIGH. Defaults to THUMBNAIL_QUALITY_COLOR_OPTION_HIGH.
    
    Returns:
    the mode for thumbnail quality for color
  - setThumbnailQualityColor
```
public void setThumbnailQualityColor(int quality)
```
    Sets the mode for thumbnail quality for color when cataloging using this asset handling set. The possible values are THUMBNAIL_QUALITY_COLOR_OPTION_NORMAL and THUMBNAIL_QUALITY_COLOR_OPTION_HIGH.
    
    Parameters:
    quality - the wanted mode for thumbnail quality for color
  - getCentralAssetLocation
```
public int getCentralAssetLocation()
```
    Returns the mode for handling the central asset location configured for the catalog when cataloging using this asset handling set. The possible values are CENTRAL_ASSET_LOCATION_OPTION_COPY_OR_MOVE and CENTRAL_ASSET_LOCATION_OPTION_REFERENCE_ORIGINAL. Defaults to CENTRAL_ASSET_LOCATION_OPTION_REFERENCE_ORIGINAL.
    
    Returns:
    the mode for handling the central asset location configured for the catalog
  - setCentralAssetLocation
```
public void setCentralAssetLocation(int cal)
```
    Sets the mode for handling the central asset location configured for the catalog when cataloging using this asset handling set. The possible values are CENTRAL_ASSET_LOCATION_OPTION_COPY_OR_MOVE and CENTRAL_ASSET_LOCATION_OPTION_REFERENCE_ORIGINAL.
    
    Parameters:
    cal - the mode for handling the central asset location configured for the catalog
  - deleteOriginalAssetAfterCopyToCentralAssetLocation
```
public boolean deleteOriginalAssetAfterCopyToCentralAssetLocation()
```
    Returns true if the original asset should be locally deleted after copying it to the central asset location configured for the catalog when cataloging using this asset handling set. Defaults to false.
    
    Returns:
    true if the original asset should be deleted after copying it to the central asset location
  - setDeleteOriginalAssetAfterCopyToCentralAssetLocation
```
public void setDeleteOriginalAssetAfterCopyToCentralAssetLocation(boolean value)
```
    Configures whether the original asset should be locally deleted after copying it to the central asset location configured for the catalog when cataloging using this asset handling set.
    
    Parameters:
    value - true if the original asset should be deleted after copying it to the central asset location, otherwise false
  - copySubAssetsToCentralLocation
```
public boolean copySubAssetsToCentralLocation()
```
    Returns true if the sub assets should also be copied to the central asset location configured for the catalog when cataloging using this asset handling set. Defaults to false.
    
    Returns:
    true if the sub assets should also be copied to the central asset location
  - setCopySubAssetsToCentralLocation
```
public void setCopySubAssetsToCentralLocation(boolean value)
```
    Configures whether the sub assets should also be copied to the central asset location configured for the catalog when cataloging using this asset handling set.
    
    Parameters:
    value - true if the sub assets should also be copied to the central asset location, otherwise false
  - getResolveOrIgnore
```
public int getResolveOrIgnore()
```
    Returns whether linked assets should be resolved. The possible values are RESOLVE_OR_IGNORE_OPTION_RESOLVE and RESOLVE_OR_IGNORE_OPTION_IGNORE. Defaults to RESOLVE_OR_IGNORE_OPTION_IGNORE.
    
    Returns:
    true if linked assets should be resolved
  - setResolveOrIgnore
```
public void setResolveOrIgnore(int val)
```
    Configures whether linked assets should be resolved. The possible values are RESOLVE_OR_IGNORE_OPTION_RESOLVE and RESOLVE_OR_IGNORE_OPTION_IGNORE. Defaults to RESOLVE_OR_IGNORE_OPTION_IGNORE.
    
    Parameters:
    val - RESOLVE_OR_IGNORE_OPTION_IGNORE to ignore linked assets otherwise RESOLVE_OR_IGNORE_OPTION_RESOLVE
  - getIsDefault
```
public boolean getIsDefault()
```
    Returns whether this asset handling set is the default asset handling set.
    
    Returns:
    true if this is the default asset handling set
  - getAutoAddNewFormats
```
public boolean getAutoAddNewFormats()
```
    Returns whether newly found formats should automatically be added to the formats list.
    
    Returns:
    true if newly found formats should automatically be added to the formats list
  - setAutoAddNewFormats
```
public void setAutoAddNewFormats(boolean value)
```
    Sets whether newly found formats should automatically be added to the formats list.
    
    Parameters:
    value - true if newly found formats should automatically be added to the formats list
  - getCatalogUnknownFormats
```
public boolean getCatalogUnknownFormats()
```
    Returns whether unknown formats should be cataloged as well.
    
    Returns:
    true if unknown formats should be cataloged as well
  - setCatalogUnknownFormats
```
public void setCatalogUnknownFormats(boolean value)
```
    Configures whether unknown formats should be cataloged as well.
    
    Parameters:
    value - true if unknown formats should be cataloged as well
  - getModulePreferencesList
```
public ModulePreferencesList getModulePreferencesList()
```
    Returns the manager for module preferences. All modules configured in this asset handling set store their preferences using this manager.
    
    Returns:
    instance managing the module preferences
  - getAssetStorageModuleList
```
public AssetModuleList getAssetStorageModuleList()
```
    Returns a list of asset storage modules of this asset handling set.
    
    Returns:
    list of asset storage modules of this asset handling set
  - getAssetProcessorModuleList
```
public AssetModuleList getAssetProcessorModuleList()
```
    Returns a list of asset processor modules of this asset handling set.
    
    Returns:
    list of asset processor modules of this asset handling set
  - getAssetMetadataBridgesModuleList
```
public AssetModuleList getAssetMetadataBridgesModuleList()
```
    Returns a list of asset metadata bridge modules of this asset handling set.
    
    Returns:
    list of asset metadata bridge modules of this asset handling set
  - getAssetGeneralPurposeModuleList
```
public AssetModuleList getAssetGeneralPurposeModuleList()
```
    Returns a list of general purpose asset modules of this asset handling set.
    
    Returns:
    list of general purpose asset modules of this asset handling set
  - getAssetFormatsList
```
public AssetFormatsList getAssetFormatsList()
```
    Returns the asset formats list of this asset handling set.
    
    Returns:
    asset formats list
  - getAssetFiltersList
```
public AssetFiltersList getAssetFiltersList()
```
    Returns the list of filters of this asset handling set.
    
    Returns:
    list of filters of this asset handling set
  - useMetadataTemplate
```
public boolean useMetadataTemplate()
```
    Returns whether a metadata template should automatically be applied when cataloging.
    
    Returns:
    true if a metadata template should automatically be applied when cataloging
    Since:
    
    7.0
  - setUseMetadataTemplate
```
public void setUseMetadataTemplate(boolean value)
```
    Set whether a metadata template should automatically be applied when cataloging.
    
    Parameters:
    value - true if a metadata template should automatically be applied when cataloging
    Since:
    
    7.0
  - useMetadataEditorForNewRecords
```
public boolean useMetadataEditorForNewRecords()
```
    Returns whether the metadata editor window should be shown for new records before saving the record.
    
    Returns:
    true if the metadata editor window should be shown
    Since:
    
    8.0
  - setUsePreFillerForNewRecords
```
public void setUsePreFillerForNewRecords(boolean value)
```
    Sets whether the metadata editor window should be shown for new records before saving the record.
    
    Parameters:
    value - true if the metadata editor window should be shown
    Since:
    
    8.0
  - useMetadataEditorForUpdatedRecords
```
public boolean useMetadataEditorForUpdatedRecords()
```
    Returns whether the metadata editor window should be shown for updated records before saving the record.
    
    Returns:
    true if the metadata editor window should be shown
    Since:
    
    8.0
  - setUsePreFillerForUpdatedRecords
```
public void setUsePreFillerForUpdatedRecords(boolean value)
```
    Sets whether the metadata editor window should be shown for updated records before saving the record.
    
    Parameters:
    value - true if the metadata editor window should be shown
    Since:
    
    8.0
  - getMetadataTemplate
```
public java.lang.String getMetadataTemplate()
```
    Returns the name of the metadata template applied when cataloging or null when not configured.
    
    Returns:
    name of the metadata template applied when cataloging or null
    Since:
    
    7.0
  - setMetadataTemplate
```
public void setMetadataTemplate(java.lang.String value)
```
    Sets the name of the metadata template applied when cataloging or null when not configured.
    
    Parameters:
    value - name of the metadata template applied when cataloging or null
    Since:
    
    7.0
  - getPreFillerRecordViewSet
```
public java.lang.String getPreFillerRecordViewSet()
```
    Returns the name of the record view set to use when showing the PreFiller or null when not configured.
    
    Returns:
    name of the record view set to use when showing the PreFiller or null when not configured.
    Since:
    
    8.0
  - setPreFillerRecordViewSet
```
public void setPreFillerRecordViewSet(java.lang.String value)
```
    Sets the name of the record view set being used when showing the PreFiller.
    
    Parameters:
    value - name of the record view set to use for the PreFiller
    Since:
    
    8.0
  - getVersioningGLVBehaviour
```
public int getVersioningGLVBehaviour()
```
    Returns the mode for handling the getting of assets when using this asset handling set. The possible values are VERSIONING_GET_BEHAVIOUR_OPTION_ALWAYS_GET_LATEST_VERSION and VERSIONING_GET_BEHAVIOUR_OPTION_ASK_FOR_VERSION. Defaults to VERSIONING_GET_BEHAVIOUR_OPTION_ALWAYS_GET_LATEST_VERSION.
    
    Returns:
    the mode for the getting of assets
    Since:
    
    7.0
  - setVersioningGLVBehaviour
```
public void setVersioningGLVBehaviour(int value)
```
    Sets the mode for handling the getting of assets when using this asset handling set. The possible values are VERSIONING_GET_BEHAVIOUR_OPTION_ALWAYS_GET_LATEST_VERSION and VERSIONING_GET_BEHAVIOUR_OPTION_ASK_FOR_VERSION.
    
    Parameters:
    value - the mode for the getting of assets
    Since:
    
    7.0
  - getCatalogMissingReferencedAssets
```
public boolean getCatalogMissingReferencedAssets()
```
    Returns whether missing referenced assets should also be cataloged. To make this work the server needs the Feature.AUTO_CATALOG_REFERENCED_ASSETS feature. Defaults to false.
    
    Returns:
    true if missing referenced assets should also be cataloged
    Since:
    
    7.0
  - setCatalogMissingReferencedAssets
```
public void setCatalogMissingReferencedAssets(boolean value)
```
    Sets whether missing referenced assets should also be cataloged. To make this work the server needs the Feature.AUTO_CATALOG_REFERENCED_ASSETS feature.
    
    Parameters:
    value - true if missing referenced assets should also be cataloged
    Since:
    
    7.0
  - getID
```
public java.lang.String getID()
```
    Returns the UID of the item in the items namespace.
    
    Specified by:
    
    getID in interface Item
    
    Returns:
    item UID
  - isDefault
```
public boolean isDefault()
```
    Returns whether this item is the default item.
    
    Specified by:
    
    isDefault in interface Item
    
    Returns:
    true if this is the default item
  - getDescription
```
public java.lang.String getDescription(int languageID)
```
    Returns the description for the given language id.
    
    Specified by:
    
    getDescription in interface Item
    
    Parameters:
    languageID - specifying the language for the description
    
    Returns:
    description text
    Since:
    
    8.0
  - setDescription
```
public void setDescription(int languageID,
                  java.lang.String description)
```
    Sets the description for the given language.
    
    Specified by:
    
    setDescription in interface Item
    
    Parameters:
    languageID - the language to set the description for
    description - the new description
    Since:
    
    8.0
  - getDisplayName
```
public java.lang.String getDisplayName(int languageID,
                              boolean fallbackToDefaultName)
```
    Returns the display name for the given language id.
    
    Specified by:
    
    getDisplayName in interface Item
    
    Parameters:
    languageID - specifying the language for the display name
    fallbackToDefaultName - when set to true this method returns the default name when now localized display name is available otherwise null
    
    Returns:
    display name
    Since:
    
    8.5
  - setDisplayName
```
public void setDisplayName(int languageID,
                  java.lang.String displayName)
```
    Sets the display name for the given language.
    
    Specified by:
    
    setDisplayName in interface Item
    
    Parameters:
    languageID - the language to set the display name for
    displayName - the new display name
    Since:
    
    8.5
  - isSharingRestricted
```
public boolean isSharingRestricted()
```
    Returns whether the set visibility is restricted to a group of users or roles.
    
    Specified by:
    
    isSharingRestricted in interface Item
    
    Returns:
    true if the set visibility is restricted to a group of users or roles
    Since:
    
    8.6
  - setSharingRestricted
```
public void setSharingRestricted(boolean value)
```
    Sets whether the set visibility is restricted to a group of users or roles.
    
    Specified by:
    
    setSharingRestricted in interface Item
    
    Parameters:
    value - set to true if the set visibility should be restricted to a group of users or roles
    Since:
    
    8.6
  - getRestrictionsList
```
public RestrictionsList getRestrictionsList()
```
    Returns the list of roles and users that are allowed to view this set. Only applicable for shared set and if isSharingRestricted() returns true.
    
    Specified by:
    
    getRestrictionsList in interface Item
    
    Returns:
    list of roles and users that are allowed to view this set
    Since:
    
    8.6
  - getWorkflowList
```
public AssetHandlingSetWorkflowList getWorkflowList()
```
    Returns the list of referenced workflows which should be started when cataloging with this asset handling set.
    
    Returns:
    list of referenced workflows
    Since:
    
    9.2
  - exportSet
```
public JPack exportSet()
```
    Exports this set into a JPack.
    
    Specified by:
    
    exportSet in interface Item
    
    Returns:
    exported data as JPack
    Since:
    
    8.1
    
    See Also:
    AssetHandlingSetList.importSet(com.canto.cumulus.utils.JPack, SetImportDuplicatesMode)

www.canto.com
Canto, the Canto logo, the Cumulus logo, and Cumulus are registered trademarks of Canto GmbH, registered in the U.S. and other countries.

Class AssetHandlingSet

Nested Class Summary

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

Field Summary

Fields inherited from class com.canto.cumulus.prefs.BaseManager

Method Summary

Methods inherited from class com.canto.cumulus.prefs.BaseManager

Methods inherited from class java.lang.Object

Field Detail

CREATE_THUMBNAIL_FROM_OPTION_USE_EMBEDDED_THUMBNAIL_IF_AVAILABLE

CREATE_THUMBNAIL_FROM_OPTION_USE_EMBEDDED_THUMBNAIL_IF_LARGE_ENOUGH

CREATE_THUMBNAIL_FROM_OPTION_USE_ENTIRE_ASSET

THUMBNAIL_SIZE_OPTION_SMALL

THUMBNAIL_SIZE_OPTION_MEDIUM

THUMBNAIL_SIZE_OPTION_LARGE

THUMBNAIL_SIZE_OPTION_CUSTOM

ADD_AND_UPDATE_OPTION_ADD_ONLY

ADD_AND_UPDATE_OPTION_ADD_AND_UPDATE

ADD_AND_UPDATE_OPTION_UPDATE_ONLY

ADD_OR_IGNORE_DUPLICATES_OPTION_ADD

ADD_OR_IGNORE_DUPLICATES_OPTION_IGNORE

WRITEBACK_METADATA_TO_ASSET_OPTION_NEVER

WRITEBACK_METADATA_TO_ASSET_OPTION_SILENTLY

WRITEBACK_METADATA_TO_ASSET_OPTION_ALWAYS

WRITEBACK_METADATA_WRITE_DESTINATION_OPTION_TO_ASSET_AND_METADATA

WRITEBACK_METADATA_WRITE_DESTINATION_OPTION_TO_METADATA

THUMBNAIL_QUALITY_LINEART_OPTION_NORMAL

THUMBNAIL_QUALITY_LINEART_OPTION_HIGH

THUMBNAIL_QUALITY_COLOR_OPTION_NORMAL

THUMBNAIL_QUALITY_COLOR_OPTION_HIGH

THUMBNAIL_QUALITY_GRAYSCALE_OPTION_NORMAL

THUMBNAIL_QUALITY_GRAYSCALE_OPTION_HIGH

CENTRAL_ASSET_LOCATION_OPTION_COPY_OR_MOVE

CENTRAL_ASSET_LOCATION_OPTION_REFERENCE_ORIGINAL

RESOLVE_OR_IGNORE_OPTION_RESOLVE

RESOLVE_OR_IGNORE_OPTION_IGNORE

VERSIONING_GET_BEHAVIOUR_OPTION_ALWAYS_GET_LATEST_VERSION

VERSIONING_GET_BEHAVIOUR_OPTION_ASK_FOR_VERSION

VERSIONING_DELETE_BEHAVIOUR_OPTION_ALWAYS_DELETE_ALL_VERSIONS

VERSIONING_DELETE_BEHAVIOUR_OPTION_ASK_FOR_VERSION

THUMBNAIL_SIZE_OTHER

dataKeys

Method Detail

getName

getCreateThumbnailFrom

setCreateThumbnailFrom

getThumbnailSize

setThumbnailSize

getThumbnailSizeOther

setThumbnailSizeOther

getOptimizeThumbnail

setOptimizeThumbnail

getAddAndUpdate

setAddAndUpdate

getAddOrIgnoreDuplicates

setAddOrIgnoreDuplicates

getWriteMDToAssets

setWriteMDToAssets

getWriteMetadataDestination

setWriteMetadataDestination

getUpdateAssetModificationDateWhenWritingMetadata

setUpdateAssetModificationDateWhenWritingMetadata

getThumbnailQualityLineArt

setThumbnailQualityLineArt

getThumbnailQualityGrayscale

setThumbnailQualityGrayscale

getThumbnailQualityColor

setThumbnailQualityColor

getCentralAssetLocation

setCentralAssetLocation

deleteOriginalAssetAfterCopyToCentralAssetLocation

setDeleteOriginalAssetAfterCopyToCentralAssetLocation

copySubAssetsToCentralLocation

setCopySubAssetsToCentralLocation

getResolveOrIgnore

setResolveOrIgnore

getIsDefault

getAutoAddNewFormats

setAutoAddNewFormats

getCatalogUnknownFormats