Package org.alfresco.service.cmr.action
Interface ParameterizedItemDefinition
-
- All Known Subinterfaces:
ActionConditionDefinition,ActionDefinition,RenderingEngineDefinition
- All Known Implementing Classes:
ActionConditionDefinitionImpl,ActionDefinitionImpl,ParameterizedItemDefinitionImpl,RenderingEngineDefinitionImpl
@AlfrescoPublicApi public interface ParameterizedItemDefinition
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleangetAdhocPropertiesAllowed()Indicates whether the parameterized item allows adhoc properties to be setjava.lang.StringgetDescription()The description of the parameterized item definitionjava.lang.StringgetName()Get the name of the rule item.java.util.List<ParameterDefinition>getParameterDefinitions()A list containing the parmameter defintions for this rule item.ParameterDefinitiongetParameterDefintion(java.lang.String name)Get the parameter definition by namejava.lang.StringgetTitle()The title of the parameterized item definitionbooleanhasParameterDefinitions()Indicates whether the parameterized item has any parameter definitions
-
-
-
Method Detail
-
getName
java.lang.String getName()
Get the name of the rule item.The name is unique and is used to identify the rule item.
- Returns:
- the name of the rule action
-
getTitle
java.lang.String getTitle()
The title of the parameterized item definition- Returns:
- the title
-
getDescription
java.lang.String getDescription()
The description of the parameterized item definition- Returns:
- the description
-
getAdhocPropertiesAllowed
boolean getAdhocPropertiesAllowed()
Indicates whether the parameterized item allows adhoc properties to be set- Returns:
- true if ashoc properties are allowed, false otherwise
-
hasParameterDefinitions
boolean hasParameterDefinitions()
Indicates whether the parameterized item has any parameter definitions- Returns:
- true if the parameterized item has any parameter definitions, false otherwise
-
getParameterDefinitions
java.util.List<ParameterDefinition> getParameterDefinitions()
A list containing the parmameter defintions for this rule item.- Returns:
- a list of parameter definitions
-
getParameterDefintion
ParameterDefinition getParameterDefintion(java.lang.String name)
Get the parameter definition by name- Parameters:
name- the name of the parameter- Returns:
- the parameter definition, null if none found
-
-