org.alfresco.service.cmr.action
Interface ParameterizedItemDefinition

All Known Subinterfaces:
ActionConditionDefinition, ActionDefinition, RenderingEngineDefinition
All Known Implementing Classes:
ActionConditionDefinitionImpl, ActionDefinitionImpl, ParameterizedItemDefinitionImpl, RenderingEngineDefinitionImpl

public interface ParameterizedItemDefinition


Method Summary
 boolean getAdhocPropertiesAllowed()
          Indicates whether the parameterized item allows adhoc properties to be set
 java.lang.String getDescription()
          The description of the parameterized item definition
 java.lang.String getName()
          Get the name of the rule item.
 java.util.List getParameterDefinitions()
          A list containing the parmameter defintions for this rule item.
 ParameterDefinition getParameterDefintion(java.lang.String name)
          Get the parameter definition by name
 java.lang.String getTitle()
          The title of the parameterized item definition
 boolean hasParameterDefinitions()
          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


getParameterDefinitions

java.util.List 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


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.