Package org.alfresco.repo.action

Class ParameterizedItemDefinitionImpl

java.lang.Object

org.alfresco.repo.action.ParameterizedItemDefinitionImpl

All Implemented Interfaces:

Serializable, ParameterizedItemDefinition

Direct Known Subclasses:

ActionConditionDefinitionImpl, ActionDefinitionImpl

public abstract class ParameterizedItemDefinitionImpl
extends Object
implements ParameterizedItemDefinition, Serializable

Rule item implementation class

Author:

Roy Wetherall

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ParameterizedItemDefinitionImpl(String name)	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	getAdhocPropertiesAllowed()	Indicates whether the parameterized item allows adhoc properties to be set
String	getDescription()	The description of the parameterized item definition
String	getName()	Get the name of the rule item.
List<ParameterDefinition>	getParameterDefinitions()	A list containing the parmameter defintions for this rule item.
ParameterDefinition	getParameterDefintion(String name)	Get the parameter definition by name
String	getTitle()	The title of the parameterized item definition
boolean	hasParameterDefinitions()	Indicates whether the parameterized item has any parameter definitions
void	setAdhocPropertiesAllowed(boolean adhocPropertiesAllowed)	Set whether adhoc properties are allowed
void	setDescriptionKey(String descriptionKey)	Set the description I18N key
void	setLocalizedParameterDefinitions(Map<Locale,List<ParameterDefinition>> parameterDefinitions)	Set the parameter definitions for the rule item with the locale specified
void	setParameterDefinitions(List<ParameterDefinition> parameterDefinitions)	Set the parameter definitions for the rule item
void	setTitleKey(String title)	Set the title of the rule item

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ParameterizedItemDefinitionImpl

public ParameterizedItemDefinitionImpl(String name)

Constructor

Parameters:

name - the name

Method Details

getName

public String getName()

Description copied from interface: ParameterizedItemDefinition

Get the name of the rule item.

The name is unique and is used to identify the rule item.

Specified by:

getName in interface ParameterizedItemDefinition

Returns:

the name of the rule action

See Also:

• ParameterizedItemDefinition.getName()

setTitleKey

public void setTitleKey(String title)

Set the title of the rule item

Parameters:

title - the title

getTitle

public String getTitle()

Description copied from interface: ParameterizedItemDefinition

The title of the parameterized item definition

Specified by:

getTitle in interface ParameterizedItemDefinition

Returns:

the title

See Also:

• ParameterizedItemDefinition.getTitle()

setDescriptionKey

public void setDescriptionKey(String descriptionKey)

Set the description I18N key

Parameters:

descriptionKey - the description key

getDescription

public String getDescription()

Description copied from interface: ParameterizedItemDefinition

The description of the parameterized item definition

Specified by:

getDescription in interface ParameterizedItemDefinition

Returns:

the description

See Also:

• ParameterizedItemDefinition.getDescription()

getAdhocPropertiesAllowed

public boolean getAdhocPropertiesAllowed()

Description copied from interface: ParameterizedItemDefinition

Indicates whether the parameterized item allows adhoc properties to be set

Specified by:

getAdhocPropertiesAllowed in interface ParameterizedItemDefinition

Returns:

true if ashoc properties are allowed, false otherwise

See Also:

• ParameterizedItemDefinition.getAdhocPropertiesAllowed()

setAdhocPropertiesAllowed

public void setAdhocPropertiesAllowed(boolean adhocPropertiesAllowed)

Set whether adhoc properties are allowed

Parameters:

adhocPropertiesAllowed - true is adhoc properties are allowed, false otherwise

setLocalizedParameterDefinitions

public void setLocalizedParameterDefinitions(Map<Locale,List<ParameterDefinition>> parameterDefinitions)

Set the parameter definitions for the rule item with the locale specified

Parameters:

parameterDefinitions - the parameter definitions

setParameterDefinitions

public void setParameterDefinitions(List<ParameterDefinition> parameterDefinitions)

Set the parameter definitions for the rule item

Parameters:

parameterDefinitions - the parameter definitions

hasParameterDefinitions

public boolean hasParameterDefinitions()

Description copied from interface: ParameterizedItemDefinition

Indicates whether the parameterized item has any parameter definitions

Specified by:

hasParameterDefinitions in interface ParameterizedItemDefinition

Returns:

true if the parameterized item has any parameter definitions, false otherwise

See Also:

• ParameterizedItemDefinition.hasParameterDefinitions()

getParameterDefinitions

public List<ParameterDefinition> getParameterDefinitions()

Description copied from interface: ParameterizedItemDefinition

A list containing the parmameter defintions for this rule item.

Specified by:

getParameterDefinitions in interface ParameterizedItemDefinition

Returns:

a list of parameter definitions

See Also:

• ParameterizedItemDefinition.getParameterDefinitions()

getParameterDefintion

public ParameterDefinition getParameterDefintion(String name)

Description copied from interface: ParameterizedItemDefinition

Get the parameter definition by name

Specified by:

getParameterDefintion in interface ParameterizedItemDefinition

Parameters:

name - the name of the parameter

Returns:

the parameter definition, null if none found

See Also:

• ParameterizedItemDefinition.getParameterDefintion(java.lang.String)