WorkflowActivity (Cumulus Java Classes Documentation)

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

```
public class WorkflowActivity
extends BaseManager
```
This class stores the settings for a single workflow activity.

Since:

9.2

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class WorkflowActivity.AssignmentMode
- Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager
  BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Nested Classes
Modifier and Type	Class and Description
`static class`	`WorkflowActivity.AssignmentMode`

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.util.Set<java.lang.String>`	`getAssetActionNames()` Returns the names of the configured asset actions.
`WorkflowActivity.AssignmentMode`	`getAssignmentMode()` Returns the assignment mode when applying this activity.
`java.lang.String`	`getDescription(int languageID)` Returns the description for the given language id.
`java.util.Set<java.lang.Integer>`	`getDestinationStateIDs()` Returns the state IDs this activity can use as destination states.
`int`	`getID()` Returns the id of this activity.
`java.lang.String`	`getMetadataTemplateName()` Return the metadata template name to use when applying this activity.
`java.lang.String`	`getName(int languageID, boolean fallbackToDefaultName)` Returns the name for the given language id.
`java.lang.String`	`getPermissionTemplateName()` Return the permission template name to use when applying this activity.
`java.lang.String`	`getRecordRestrictionQueryName()` Return the query name to use when using the record restriction for this activity.
`java.lang.String`	`getRecordRestrictionQueryString()` Return the query string to use when using the record restriction for this activity.
`java.util.Set<java.lang.Integer>`	`getSourceStateIDs()` Returns the state IDs for which this activity should be available.
`RestrictionsList`	`getStaticAssignmentList()` Returns the list of roles and users that are assigned if the assignment mode is `WorkflowActivity.AssignmentMode.STATIC_ASSIGNMENT`.
`boolean`	`getUseAssetActions()` Returns whether this activity should apply one or more asset action.
`boolean`	`getUseMetadataTemplate()` Returns whether this activity should apply a metadata template.
`boolean`	`getUsePermissionTemplate()` Returns whether this activity should apply a permission template.
`RestrictionsList`	`getUserRestrictionsList()` Returns the list of roles and users that are allowed to use this activity if `isUserRestricted()` returns true.
`boolean`	`isInitialActivity()` Returns whether this activity should be available as an initial activity.
`boolean`	`isRecordRestricted()` Returns whether this activity should only be available for records matching a configured query.
`boolean`	`isUserRequiredToSpecifyNewAssignments()` Returns whether the user needs to be asked for new assignments when applying this activity.
`boolean`	`isUserRestricted()` Returns whether this activity should only be available for a specified list of users and roles.
`void`	`setAssetActionNames(java.util.Set<java.lang.String> actions)` Configures the asset action names.
`void`	`setAssignmentMode(WorkflowActivity.AssignmentMode assignmentMode)` Configures the assignment mode when applying this activity.
`void`	`setDescription(int languageID, java.lang.String description)` Sets the description for the given language.
`void`	`setDestinationStateIDs(java.util.Set<java.lang.Integer> ids)` Configures the state IDs this activity can use as destination states.
`void`	`setInitialActivity(boolean value)` Specifies whether this activity should be available as an initial activity.
`void`	`setMetadataTemplateName(java.lang.String name)` Configures the metadata template name to use when applying this activity.
`void`	`setName(int languageID, java.lang.String name)` Sets the name for the given language.
`void`	`setPermissionTemplateName(java.lang.String name)` Configures the permission template name to use when applying this activity.
`void`	`setRecordRestricted(boolean value)` Specifies whether this activity should only be available for a specified list of records and roles.
`void`	`setRecordRestrictionQueryName(java.lang.String queryName)` Configures the query name to use when using the record restriction for this activity.
`void`	`setRecordRestrictionQueryString(java.lang.String query)` Configures the query string to use when using the record restriction for this activity as a fallback in case the configured query is ont available.
`void`	`setSourceStateIDs(java.util.Set<java.lang.Integer> ids)` Configures the state IDs for which this activity should be available.
`void`	`setUseAssetActions(boolean value)` Specifies whether this activity should apply one or more asset action.
`void`	`setUseMetadataTemplate(boolean value)` Specifies whether this activity should apply a metadata template.
`void`	`setUsePermissionTemplate(boolean value)` Specifies whether this activity should apply a permission template.
`void`	`setUserRestricted(boolean value)` Specifies whether this activity should only be available for a specified list of users and roles.

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 activity.
    
    Returns:
    id of this activity
  - 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
  - isUserRestricted
```
public boolean isUserRestricted()
```
    Returns whether this activity should only be available for a specified list of users and roles.
    
    Returns:
    true if the activity is only available for a specified list of users and roles
  - setUserRestricted
```
public void setUserRestricted(boolean value)
```
    Specifies whether this activity should only be available for a specified list of users and roles.
    
    Parameters:
    value - true if the activity should only available for a specified list of users and roles, otherwise false
  - getUserRestrictionsList
```
public RestrictionsList getUserRestrictionsList()
```
    Returns the list of roles and users that are allowed to use this activity if isUserRestricted() returns true.
    
    Returns:
    list of roles and users that are allowed to use this activity
  - isInitialActivity
```
public boolean isInitialActivity()
```
    Returns whether this activity should be available as an initial activity. Initial activities can be used to start a workflow for a record.
    
    Returns:
    true if the activity is available as an initial activity
  - setInitialActivity
```
public void setInitialActivity(boolean value)
```
    Specifies whether this activity should be available as an initial activity. Initial activities can be used to start a workflow for a record.
    
    Parameters:
    value - true if the activity is available as an initial activity, otherwise false
    
    Throws:
    
    java.lang.IllegalStateException - when not exactly destination state has been configured
  - isRecordRestricted
```
public boolean isRecordRestricted()
```
    Returns whether this activity should only be available for records matching a configured query.
    
    Returns:
    true if the activity is only available for records matching a configured query
  - setRecordRestricted
```
public void setRecordRestricted(boolean value)
```
    Specifies whether this activity should only be available for a specified list of records and roles.
    
    Parameters:
    value - true if the activity should only available for a specified list of records and roles, otherwise false
  - getRecordRestrictionQueryName
```
public java.lang.String getRecordRestrictionQueryName()
```
    Return the query name to use when using the record restriction for this activity.
    
    Returns:
    query name to use when using the record restriction for this activity or null if not configured
  - setRecordRestrictionQueryName
```
public void setRecordRestrictionQueryName(java.lang.String queryName)
```
    Configures the query name to use when using the record restriction for this activity.
    
    Parameters:
    queryName - query name to use when using the record restriction for this activity
  - getRecordRestrictionQueryString
```
public java.lang.String getRecordRestrictionQueryString()
```
    Return the query string to use when using the record restriction for this activity. Try to look up the query referenced by getRecordRestrictionQueryName() using Preferences.getRecordQuery(String) first and use this query string only as a fallback in case that query is currently not available.
    
    Returns:
    query string or null if not yet configured
  - setRecordRestrictionQueryString
```
public void setRecordRestrictionQueryString(java.lang.String query)
```
    Configures the query string to use when using the record restriction for this activity as a fallback in case the configured query is ont available.
    
    Parameters:
    query - query string
  - getUseMetadataTemplate
```
public boolean getUseMetadataTemplate()
```
    Returns whether this activity should apply a metadata template.
    
    Returns:
    true if the activity should apply a metadata template
  - setUseMetadataTemplate
```
public void setUseMetadataTemplate(boolean value)
```
    Specifies whether this activity should apply a metadata template.
    
    Parameters:
    value - true if the activity should apply a metadata template, otherwise false
  - getMetadataTemplateName
```
public java.lang.String getMetadataTemplateName()
```
    Return the metadata template name to use when applying this activity.
    
    Returns:
    metadata template name to use when applying this activity or null if not configured
  - setMetadataTemplateName
```
public void setMetadataTemplateName(java.lang.String name)
```
    Configures the metadata template name to use when applying this activity.
    
    Parameters:
    name - metadata template name to use when applying this activity.
  - getUsePermissionTemplate
```
public boolean getUsePermissionTemplate()
```
    Returns whether this activity should apply a permission template.
    
    Returns:
    true if the activity should apply a permission template
  - setUsePermissionTemplate
```
public void setUsePermissionTemplate(boolean value)
```
    Specifies whether this activity should apply a permission template.
    
    Parameters:
    value - true if the activity should apply a permission template, otherwise false
  - getPermissionTemplateName
```
public java.lang.String getPermissionTemplateName()
```
    Return the permission template name to use when applying this activity.
    
    Returns:
    permission template name to use when applying this activity or null if not configured
  - setPermissionTemplateName
```
public void setPermissionTemplateName(java.lang.String name)
```
    Configures the permission template name to use when applying this activity.
    
    Parameters:
    name - permission template name to use when applying this activity.
  - getUseAssetActions
```
public boolean getUseAssetActions()
```
    Returns whether this activity should apply one or more asset action.
    
    Returns:
    true if the activity should apply one or more asset action
  - setUseAssetActions
```
public void setUseAssetActions(boolean value)
```
    Specifies whether this activity should apply one or more asset action.
    
    Parameters:
    value - true if the activity should apply one or more asset action, otherwise false
  - getAssetActionNames
```
public java.util.Set<java.lang.String> getAssetActionNames()
```
    Returns the names of the configured asset actions.
    
    Returns:
    configured asset action names
    See Also:
    getUseAssetActions()
  - setAssetActionNames
```
public void setAssetActionNames(java.util.Set<java.lang.String> actions)
```
    Configures the asset action names.
    
    Parameters:
    actions - configured asset action names to store or null to clear
    See Also:
    getUseAssetActions()
  - getAssignmentMode
```
public WorkflowActivity.AssignmentMode getAssignmentMode()
```
    Returns the assignment mode when applying this activity.
    
    Returns:
    assignment mode when applying this activity
  - isUserRequiredToSpecifyNewAssignments
```
public boolean isUserRequiredToSpecifyNewAssignments()
```
    Returns whether the user needs to be asked for new assignments when applying this activity.
    
    Returns:
    true if the user needs to be asked for new assignments when applying this activity, false otherwise.
  - getStaticAssignmentList
```
public RestrictionsList getStaticAssignmentList()
```
    Returns the list of roles and users that are assigned if the assignment mode is WorkflowActivity.AssignmentMode.STATIC_ASSIGNMENT.
    
    Returns:
    list of roles and users that are assigned if the assignment mode is WorkflowActivity.AssignmentMode.STATIC_ASSIGNMENT
  - getSourceStateIDs
```
public java.util.Set<java.lang.Integer> getSourceStateIDs()
```
    Returns the state IDs for which this activity should be available.
    
    Returns:
    state IDs for which this activity should be available
  - setSourceStateIDs
```
public void setSourceStateIDs(java.util.Set<java.lang.Integer> ids)
```
    Configures the state IDs for which this activity should be available.
    
    Parameters:
    ids - state IDs for which this activity should be available
  - getDestinationStateIDs
```
public java.util.Set<java.lang.Integer> getDestinationStateIDs()
```
    Returns the state IDs this activity can use as destination states.
    
    Returns:
    state IDs this activity can use as destination states
  - setDestinationStateIDs
```
public void setDestinationStateIDs(java.util.Set<java.lang.Integer> ids)
```
    Configures the state IDs this activity can use as destination states.
    
    Parameters:
    ids - state IDs this activity can use as destination states
  - setAssignmentMode
```
public void setAssignmentMode(WorkflowActivity.AssignmentMode assignmentMode)
```
    Configures the assignment mode when applying this activity.
    
    Parameters:
    assignmentMode - assignment mode when applying this activity

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 WorkflowActivity

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

Method Detail

getID

getDescription

setDescription

getName

setName

isUserRestricted

setUserRestricted

getUserRestrictionsList

isInitialActivity

setInitialActivity

isRecordRestricted

setRecordRestricted

getRecordRestrictionQueryName

setRecordRestrictionQueryName

getRecordRestrictionQueryString

setRecordRestrictionQueryString

getUseMetadataTemplate

setUseMetadataTemplate

getMetadataTemplateName

setMetadataTemplateName

getUsePermissionTemplate

setUsePermissionTemplate

getPermissionTemplateName

setPermissionTemplateName

getUseAssetActions

setUseAssetActions

getAssetActionNames

setAssetActionNames

getAssignmentMode

isUserRequiredToSpecifyNewAssignments

getStaticAssignmentList

getSourceStateIDs

setSourceStateIDs

getDestinationStateIDs

setDestinationStateIDs

setAssignmentMode