com.canto.cumulus.prefs

Class AssetAction

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.AssetAction

All Implemented Interfaces:

Item

public class AssetAction
extends BaseManager
implements Item

This class represents an Asset Action and its settings.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AssetAction.ErrorMode This enum specifies the different types for the asset action error mode.
static class	AssetAction.ErrorModeFileFormats This enum specifies the different types of handling assets that do not fit the configured asset type restriction.

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

BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

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

TYPE_EJP, TYPE_NATIVE

Method Summary

Methods

Modifier and Type	Method and Description
JPack	exportSet() Exports this set into a JPack.
AssetActionPackers	getAssetActionPackers() The manager for the list of packers for this action.
AssetActionProcessors	getAssetActionProcessors() The manager for the list of processors for this action.
AssetActionSavers	getAssetActionSavers() The manager for the list of savers for this action.
java.lang.String	getAssetHandlingSet() Returns the name of the asset handling set being used when executing the asset action and useAssetHandlingSet() returning true.
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.
AssetAction.ErrorMode	getErrorMode() Return the error mode for this asset action.
java.util.Set<java.lang.String>	getFileFormatFilterList() Returns the list of allowed file formats for this asset action.
java.lang.String	getID() Returns the UID of the item in the items namespace.
AssetAction.ErrorModeFileFormats	getInvalidFileFormatsErrorMode() Return the error mode for assets that don't match the allowed list of file formats.
boolean	getIsDefault() Returns whether this is the default asset action.
java.lang.String	getName() Returns the name of this asset action.
RestrictionsList	getRestrictionsList() Returns the list of roles and users that are allowed to view this set.
boolean	getUseFileFormatFilter() Returns whether this asset action should only process assets of a specific file type.
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	setAssetHandlingSet(java.lang.String value) Sets the asset handling set to use when executing this action.
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	setErrorMode(AssetAction.ErrorMode mode) Sets the error mode for this asset action.
void	setFileFormatFilterList(java.util.Set<java.lang.String> list) Configures the list of allowed file formats for this asset action.
void	setInvalidFileFormatsErrorMode(AssetAction.ErrorModeFileFormats mode) Sets the error mode for assets that don't match the allowed list of file formats.
void	setSharingRestricted(boolean value) Sets whether the set visibility is restricted to a group of users or roles.
void	setUseAssetHandlingSet(boolean value) Sets whether this action should use a specific asset handling set when being executed.
void	setUseFileFormatFilter(boolean use) Configures whether this asset action should only process assets of a specific file type.
boolean	useAssetHandlingSet() Returns whether this action should use a specific asset handling set when being executed.

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

Method Detail

getName

public java.lang.String getName()

Returns the name of this asset action.

Returns:

name of this asset action

getIsDefault

public boolean getIsDefault()

Returns whether this is the default asset action.

Returns:

true if this is the default asset action

useAssetHandlingSet

public boolean useAssetHandlingSet()

Returns whether this action should use a specific asset handling set when being executed.

Returns:

true if a specific asset handling set should be used

setUseAssetHandlingSet

public void setUseAssetHandlingSet(boolean value)

Sets whether this action should use a specific asset handling set when being executed.

Parameters:

value - true if a specific asset handling set should be used

getErrorMode

public AssetAction.ErrorMode getErrorMode()

Return the error mode for this asset action. This specifies whether erroneous assets are skipped or fail the entire asset action.

Returns:

error mode of this asset action

Since:

8.5

setErrorMode

public void setErrorMode(AssetAction.ErrorMode mode)

Sets the error mode for this asset action. This specifies whether erroneous assets are skipped or fail the entire asset action.

Parameters:

mode - error mode of this asset action

Since:

8.5

getInvalidFileFormatsErrorMode

public AssetAction.ErrorModeFileFormats getInvalidFileFormatsErrorMode()

Return the error mode for assets that don't match the allowed list of file formats.

Returns:

error mode for assets that don't match the allowed list of file formats

Since:

8.5

setInvalidFileFormatsErrorMode

public void setInvalidFileFormatsErrorMode(AssetAction.ErrorModeFileFormats mode)

Sets the error mode for assets that don't match the allowed list of file formats.

Parameters:

mode - error mode for assets that don't match the allowed list of file formats

Since:

8.5

getUseFileFormatFilter

public boolean getUseFileFormatFilter()

Returns whether this asset action should only process assets of a specific file type.

Returns:

whether this asset action should only process assets of a specific file type.

Since:

8.5

setUseFileFormatFilter

public void setUseFileFormatFilter(boolean use)

Configures whether this asset action should only process assets of a specific file type.

Parameters:

use - whether this asset action should only process assets of a specific file type

Since:

8.5

getFileFormatFilterList

public java.util.Set<java.lang.String> getFileFormatFilterList()

Returns the list of allowed file formats for this asset action.

Returns:

list of allowed file formats for this asset action

Since:

8.5

setFileFormatFilterList

public void setFileFormatFilterList(java.util.Set<java.lang.String> list)

Configures the list of allowed file formats for this asset action.

Parameters:

list - list of allowed file formats for this asset action

Since:

8.5

getAssetHandlingSet

public java.lang.String getAssetHandlingSet()

Returns the name of the asset handling set being used when executing the asset action and useAssetHandlingSet() returning true.

Returns:

name of an asset handling set or null if not specified

setAssetHandlingSet

public void setAssetHandlingSet(java.lang.String value)

Sets the asset handling set to use when executing this action. You also need to set setUseAssetHandlingSet(boolean) to true.

Parameters:

value - the name of the asset handling set to use

getAssetActionProcessors

public AssetActionProcessors getAssetActionProcessors()

The manager for the list of processors for this action.

Returns:

manager for the list of processors

getAssetActionPackers

public AssetActionPackers getAssetActionPackers()

The manager for the list of packers for this action.

Returns:

manager for the list of packers

getAssetActionSavers

public AssetActionSavers getAssetActionSavers()

The manager for the list of savers for this action.

Returns:

manager for the list of savers

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

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:

AssetActionsList.importSet(com.canto.cumulus.utils.JPack, SetImportDuplicatesMode)

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