com.canto.cumulus.prefs

Class WorkflowState

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.WorkflowState

public class WorkflowState
extends BaseManager

This class stores the settings for a single workflow state.

Since:

9.2

Nested Class Summary

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
java.lang.String	getDescription(int languageID) Returns the description for the given language id.
int	getID() Returns the id of this state.
java.lang.String	getName(int languageID, boolean fallbackToDefaultName) Returns the name for the given language id.
java.util.Set<java.lang.String>	getToolboxActionKeys() Gets the keys of all stored toolbox actions for this workflow state
void	setDescription(int languageID, java.lang.String description) Sets the description for the given language.
void	setName(int languageID, java.lang.String name) Sets the name for the given language.
void	setToolboxActionKeys(java.util.Set<java.lang.String> toolboxActionKeys) Sets toolbox action keys for this state

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

getID

public int getID()

Returns the id of this state.

Returns:

id of this state

getDescription

public java.lang.String getDescription(int languageID)

Returns the description for the given language id.

Parameters:

languageID - specifying the language for the description

Returns:

description text

setDescription

public void setDescription(int languageID,
                  java.lang.String description)

Sets the description for the given language.

Parameters:

languageID - the language to set the description for

description - the new description

getName

public java.lang.String getName(int languageID,
                       boolean fallbackToDefaultName)

Returns the name for the given language id.

Parameters:

languageID - specifying the language for the name

fallbackToDefaultName - when set to true this method returns the default name when no localized name is available otherwise null

Returns:

name

setName

public void setName(int languageID,
           java.lang.String name)

Sets the name for the given language.

Parameters:

languageID - the language to set the name for

name - the new name

getToolboxActionKeys

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

Gets the keys of all stored toolbox actions for this workflow state

Returns:

set of toolbox action keys

Since:

11.1

setToolboxActionKeys

public void setToolboxActionKeys(java.util.Set<java.lang.String> toolboxActionKeys)

Sets toolbox action keys for this state

Parameters:

toolboxActionKeys - set of toolbox action keys

Since:

11.1