org.alfresco.repo.action
Class ParameterizedItemAbstractBase

java.lang.Object
  extended by org.alfresco.repo.action.CommonResourceAbstractBase
      extended by org.alfresco.repo.action.ParameterizedItemAbstractBase
All Implemented Interfaces:
org.springframework.beans.factory.BeanNameAware
Direct Known Subclasses:
ActionConditionEvaluatorAbstractBase, ActionExecuterAbstractBase

public abstract class ParameterizedItemAbstractBase
extends CommonResourceAbstractBase

Rule item abstract base.

Helper base class used by the action exector and condition evaluator implementations.


Field Summary
protected static java.lang.String DISPLAY_LABEL
           
protected  RuntimeActionService runtimeActionService
          Action service
 
Fields inherited from class org.alfresco.repo.action.CommonResourceAbstractBase
name
 
Constructor Summary
ParameterizedItemAbstractBase()
           
 
Method Summary
protected abstract  void addParameterDefinitions(java.util.List paramList)
          Adds the parameter definitions to the list
protected  void checkMandatoryProperties(ParameterizedItem ruleItem, ParameterizedItemDefinition ruleItemDefinition)
          Checked whether all the mandatory parameters for the rule item have been assigned.
protected  boolean getAdhocPropertiesAllowed()
          Indicates whether adhoc property definitions are allowed or not
protected  java.lang.String getDescriptionKey()
          Gets the description I18N key
protected  java.lang.String getParamDisplayLabel(java.lang.String paramName)
          Gets the parameter definition display label from the properties file.
protected  java.util.List getParameterDefintions()
          Gets a list containing the parameter definitions for this rule item.
protected  java.lang.String getTitleKey()
          Gets the title I18N key
 void setRuntimeActionService(RuntimeActionService runtimeActionService)
          Sets the action service
 java.lang.String toString()
           
 
Methods inherited from class org.alfresco.repo.action.CommonResourceAbstractBase
setBeanName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DISPLAY_LABEL

protected static final java.lang.String DISPLAY_LABEL
See Also:
Constant Field Values

runtimeActionService

protected RuntimeActionService runtimeActionService
Action service

Constructor Detail

ParameterizedItemAbstractBase

public ParameterizedItemAbstractBase()
Method Detail

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
Returns:
Return a short title and description string

getParameterDefintions

protected java.util.List getParameterDefintions()
Gets a list containing the parameter definitions for this rule item.

Returns:
the list of parameter definitions

addParameterDefinitions

protected abstract void addParameterDefinitions(java.util.List paramList)
Adds the parameter definitions to the list

Parameters:
paramList - the parameter definitions list

setRuntimeActionService

public void setRuntimeActionService(RuntimeActionService runtimeActionService)
Sets the action service

Parameters:
actionRegistration - the action service

getTitleKey

protected java.lang.String getTitleKey()
Gets the title I18N key

Returns:
the title key

getDescriptionKey

protected java.lang.String getDescriptionKey()
Gets the description I18N key

Returns:
the description key

getAdhocPropertiesAllowed

protected boolean getAdhocPropertiesAllowed()
Indicates whether adhoc property definitions are allowed or not

Returns:
true if they are, by default false

getParamDisplayLabel

protected java.lang.String getParamDisplayLabel(java.lang.String paramName)
Gets the parameter definition display label from the properties file.

Parameters:
paramName - the name of the parameter
Returns:
the diaplay label of the parameter

checkMandatoryProperties

protected void checkMandatoryProperties(ParameterizedItem ruleItem,
                                        ParameterizedItemDefinition ruleItemDefinition)
Checked whether all the mandatory parameters for the rule item have been assigned.

Parameters:
ruleItem - the rule item
ruleItemDefinition - the rule item definition


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