com.adobe.granite.workflow.launcher

Class ConfigEntry

java.lang.Object

com.adobe.granite.workflow.launcher.ConfigEntry

@ProviderType
public class ConfigEntry
extends java.lang.Object

The ConfigEntry represents one workflow launcher configuration entry

Constructor Summary

Constructors

Constructor and Description
ConfigEntry(int eventType, java.lang.String glob, java.lang.String nodetype, java.util.List<java.lang.String> whereClauses, java.lang.String workflow, java.lang.String id, java.lang.String description, boolean enabled, java.util.List<java.lang.String> excludeList, java.util.List<java.lang.String> runModes, java.util.List<java.lang.String> features, java.util.List<java.lang.String> disabledFeatures) Construct a ConfigEntry with the specified information.
ConfigEntry(int eventType, java.lang.String glob, java.lang.String nodetype, java.lang.String whereClause, java.lang.String workflow, java.lang.String id, java.lang.String description, boolean enabled, java.util.List<java.lang.String> excludeList, java.util.List<java.lang.String> runModes) Deprecated.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Get the description for this launcher configuration.
java.util.List<java.lang.String>	getDisabledFeatures() return a list of features which must be disabled or not found for this launcher configuration to be enabled
int	getEventType() Return the JCR Event Type that triggers this config.
java.util.List<java.lang.String>	getExcludeList() Returns a list of exclude conditions.
java.util.List<java.lang.String>	getFeatures() return a list of features which must be enabled for this launcher configuration to be enabled
java.lang.String	getGlob() Returns the path pattern that triggers this launcher configuration.
java.lang.String	getId() Return the ID of this trigger.
java.lang.String	getNodetype() Get the node type associated with this launcher.
java.util.List<java.lang.String>	getRunModes() Return the list of runmode associated with this launcher configuration.
java.lang.String	getWhereClause() Deprecated. use #getWhereClauses()
java.util.List<java.lang.String>	getWhereClauses() Return the where clause for this trigger.
java.lang.String	getWorkflow() Return the name of the workflow to trigger.
int	hashCode()
boolean	isEnabled() Returns if this launcher configuration is enabled or not.
void	setDescription(java.lang.String description) Set the description for this launcher configuration.
void	setDisabledFeatures(java.util.List<java.lang.String> disabledFeatures) sets a list of features which must be disabled for this launcher configuration to be enabled
void	setEnabled(boolean enabled) Enables or disables this launcher configuration.
void	setEventType(int eventType) Set the event type to watch.
void	setExcludeList(java.util.List<java.lang.String> excludeList) Set the list of exclude conditions.
void	setFeatures(java.util.List<java.lang.String> features) sets a list of features which must be enabled for this launcher configuration to be enabled
void	setGlob(java.lang.String glob) Set the path pattern to trigger this launcher configuration.
void	setId(java.lang.String id) Set the Id of this trigger
void	setNodetype(java.lang.String nodetype) Set the node type associated with this launcher.
void	setRunModes(java.util.List<java.lang.String> runModes) Set the run moodes associated with this launcher configuration.
void	setWhereClause(java.lang.String whereClause) Deprecated. use #setWhereClauses
void	setWhereClauses(java.util.List<java.lang.String> whereClauses) Set the where clause for this trigger.
void	setWorkflow(java.lang.String workflow) Set the name of the workflow to trigger.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfigEntry

public ConfigEntry(int eventType,
                   java.lang.String glob,
                   java.lang.String nodetype,
                   java.lang.String whereClause,
                   java.lang.String workflow,
                   java.lang.String id,
                   java.lang.String description,
                   boolean enabled,
                   java.util.List<java.lang.String> excludeList,
                   java.util.List<java.lang.String> runModes)

Deprecated.

Construct a ConfigEntry with the specified information.

Parameters:

eventType - one of javax.jcr.observation.Event#NODE_ADDED

glob - the path pattern, can be regexp, where the event should be watching

nodetype - type of node to watch

whereClause - node property conditions to watch

workflow - the name of the workflow to trigger

id - the id for this config

description - description for this config

enabled - true if the enabled, false for disabled

excludeList - conditions to exclude from the event

runModes - runmodes for this config

ConfigEntry

public ConfigEntry(int eventType,
                   java.lang.String glob,
                   java.lang.String nodetype,
                   java.util.List<java.lang.String> whereClauses,
                   java.lang.String workflow,
                   java.lang.String id,
                   java.lang.String description,
                   boolean enabled,
                   java.util.List<java.lang.String> excludeList,
                   java.util.List<java.lang.String> runModes,
                   java.util.List<java.lang.String> features,
                   java.util.List<java.lang.String> disabledFeatures)

Construct a ConfigEntry with the specified information.

Parameters:

eventType - one of javax.jcr.observation.Event#NODE_ADDED

glob - the path pattern, can be regexp, where the event should be watching

nodetype - type of node to watch

whereClauses - list of node property conditions. All conditions must be TRUE to launch the workflow. A single condition entry can contain || for OR conditions

workflow - the name of the workflow to trigger

id - the id for this config

description - description for this config

enabled - true if the enabled, false for disabled

excludeList - conditions to exclude from the event

runModes - runmodes for this config

features - features which must be enabled for this launcher to be active

disabledFeatures - features which must be disabled for this launcher to be active

Method Detail

getWorkflow

public java.lang.String getWorkflow()

Return the name of the workflow to trigger.

Returns:

workflow name.

setWorkflow

public void setWorkflow(java.lang.String workflow)

Set the name of the workflow to trigger.

Parameters:

workflow - workflow name

getEventType

public int getEventType()

Return the JCR Event Type that triggers this config.

Returns:

event type

setEventType

public void setEventType(int eventType)

Set the event type to watch.

Parameters:

eventType - event type to listen to.

getGlob

public java.lang.String getGlob()

Returns the path pattern that triggers this launcher configuration.

Returns:

path pattern.

setGlob

public void setGlob(java.lang.String glob)

Set the path pattern to trigger this launcher configuration.

Parameters:

glob - path pattern.

getNodetype

public java.lang.String getNodetype()

Get the node type associated with this launcher.

Returns:

node type

setNodetype

public void setNodetype(java.lang.String nodetype)

Set the node type associated with this launcher.

Parameters:

nodetype - the node type

getWhereClause

public java.lang.String getWhereClause()

Deprecated. use #getWhereClauses()

Return the where clause for this trigger. The where clause is a condition of node properties, e.g. approved==true

Returns:

where clause

getWhereClauses

public java.util.List<java.lang.String> getWhereClauses()

Return the where clause for this trigger. The where clause is a condition of node properties, e.g. approved==true

Returns:

where clause

setWhereClause

public void setWhereClause(java.lang.String whereClause)

Deprecated. use #setWhereClauses

Set the where clause for this trigger.

Parameters:

whereClause - condition

setWhereClauses

public void setWhereClauses(java.util.List<java.lang.String> whereClauses)

Set the where clause for this trigger.

Parameters:

whereClauses - conditions

getId

public java.lang.String getId()

Return the ID of this trigger.

Returns:

id

setId

public void setId(java.lang.String id)

Set the Id of this trigger

Parameters:

id - trigger id.

getDescription

public java.lang.String getDescription()

Get the description for this launcher configuration.

Returns:

description

setDescription

public void setDescription(java.lang.String description)

Set the description for this launcher configuration.

Parameters:

description - a new description.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isEnabled

public boolean isEnabled()

Returns if this launcher configuration is enabled or not.

Returns:

true if the configuration is enabled, false otherwise.

setEnabled

public void setEnabled(boolean enabled)

Enables or disables this launcher configuration.

Parameters:

enabled - true to enable this configuration, false otherwise.

getExcludeList

public java.util.List<java.lang.String> getExcludeList()

Returns a list of exclude conditions. If conditions in this list evaluate to true the launcher configuration does not trigger.

Returns:

list of conditions

setExcludeList

public void setExcludeList(java.util.List<java.lang.String> excludeList)

Set the list of exclude conditions.

Parameters:

excludeList - new exclude conditions list.

getRunModes

public java.util.List<java.lang.String> getRunModes()

Return the list of runmode associated with this launcher configuration.

Returns:

list of run modes.

setRunModes

public void setRunModes(java.util.List<java.lang.String> runModes)

Set the run moodes associated with this launcher configuration.

Parameters:

runModes - list of runmodes.

getFeatures

public java.util.List<java.lang.String> getFeatures()

return a list of features which must be enabled for this launcher configuration to be enabled

Returns:

list of features for this launcher

getDisabledFeatures

public java.util.List<java.lang.String> getDisabledFeatures()

return a list of features which must be disabled or not found for this launcher configuration to be enabled

Returns:

list of features for this launcher

setFeatures

public void setFeatures(java.util.List<java.lang.String> features)

sets a list of features which must be enabled for this launcher configuration to be enabled

Parameters:

features - list of features for this launcher

setDisabledFeatures

public void setDisabledFeatures(java.util.List<java.lang.String> disabledFeatures)

sets a list of features which must be disabled for this launcher configuration to be enabled

Parameters:

disabledFeatures - list of features which must be disabled

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object