org.kuali.rice.kew.framework.rule.attribute
Interface WorkflowRuleAttributeHandlerService

All Known Implementing Classes:

WorkflowRuleAttributeHandlerServiceImpl

public interface WorkflowRuleAttributeHandlerService

A remotable service which handles processing of a client application's document search customizations.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

List<RoleName>	getRoleNames(String attributeName) Gets a List of RoleName based on the passed role attribute name.
List<RemotableAttributeField>	getRoutingDataRows(String attributeName) Gets a List of RemotableAttributeField based on the passed workflow rule or searchable attribute name.
List<RemotableAttributeField>	getRuleRows(String attributeName) Gets a List of RemotableAttributeField based on the passed workflow rule attribute name.
List<RemotableAttributeField>	getSearchRows(String attributeName) Gets a List of RemotableAttributeField based on the passed workflow rule or searchable attribute name.
boolean	isWorkflowRuleAttribute(String attributeName) Returns true if the attribute with the provided name is an instance of WorkflowRuleAttribute
ValidationResults	validateRoutingData(String attributeName, Map<String,String> paramMap) Validates routingData values in the incoming map.
ValidationResults	validateRuleData(String attributeName, Map<String,String> paramMap) Validates ruleExtension values in the incoming map.
ValidationResults	validateSearchData(String attributeName, Map<String,String> paramMap) Validates searchData values in the incoming map.

Method Detail

isWorkflowRuleAttribute

boolean isWorkflowRuleAttribute(String attributeName)

Returns true if the attribute with the provided name is an instance of WorkflowRuleAttribute

Parameters:

attributeName - name of the WorkflowRuleAttribute. cannot be null or blank.

Throws:

RiceIllegalArgumentException - if the attributeName is null or blank

RiceIllegalArgumentException - if the WorkflowRuleAttribute is not found

getRuleRows

List<RemotableAttributeField> getRuleRows(String attributeName)
                                          throws RiceIllegalArgumentException

Gets a List of RemotableAttributeField based on the passed workflow rule attribute name. This method loads loads up a WorkflowRuleAttribute and determines the fields for a RuleExtension

Parameters:

attributeName - name of the WorkflowRuleAttribute. cannot be null or blank.

Returns:

an immutable list of RemotableAttributeField. Will not return null.

Throws:

RiceIllegalArgumentException - if the attributeName is null or blank

RiceIllegalArgumentException - if the WorkflowRuleAttribute is not found

getSearchRows

List<RemotableAttributeField> getSearchRows(String attributeName)
                                            throws RiceIllegalArgumentException

Gets a List of RemotableAttributeField based on the passed workflow rule or searchable attribute name. This method loads loads up either a WorkflowRuleAttribute or WorkflowRuleSearchAttribute and determines the fields for a RuleExtension.

Parameters:

attributeName - name of the WorkflowRuleAttribute. cannot be null or blank.

Returns:

an immutable list of RemotableAttributeField. Will not return null.

Throws:

RiceIllegalArgumentException - if the attributeName is null or blank

RiceIllegalArgumentException - if the WorkflowRuleAttribute is not found

getRoutingDataRows

List<RemotableAttributeField> getRoutingDataRows(String attributeName)
                                                 throws RiceIllegalArgumentException

Gets a List of RemotableAttributeField based on the passed workflow rule or searchable attribute name. This method loads loads up either a WorkflowRuleAttribute or WorkflowRuleSearchAttribute and determines the routing data fields for a RuleExtension.

RoutingDataRows contain Rows describing the UI-level presentation of the ruleData fields used to determine where a given document would be routed according to the associated rule.

Parameters:

attributeName - name of the WorkflowRuleAttribute. cannot be null or blank.

Returns:

an immutable list of RemotableAttributeField. Will not return null.

Throws:

RiceIllegalArgumentException - if the attributeName is null or blank

RiceIllegalArgumentException - if the WorkflowRuleAttribute is not found

validateRoutingData

ValidationResults validateRoutingData(String attributeName,
                                      Map<String,String> paramMap)
                                      throws RiceIllegalArgumentException

Validates routingData values in the incoming map. Called by the UI during rule creation. This method is responsible for validating and setting the data entered on the form from the UI of the routing report to the Rule's attribute. The values will be in a Map with the key being the key of the RuleExtensionValue and the value being the value of the data entered from the UI. This method is used for the routing report which may have different fields than the rule data.

Parameters:

attributeName - name of the WorkflowRuleAttribute. cannot be null or blank.

paramMap - Map containing the names and values of the routing data for this Attribute

Returns:

ValidationResults. Will not return null.

Throws:

RiceIllegalArgumentException - if the attributeName is null or blank

RiceIllegalArgumentException - if the WorkflowRuleAttribute is not found

validateSearchData

ValidationResults validateSearchData(String attributeName,
                                     Map<String,String> paramMap)
                                     throws RiceIllegalArgumentException

Validates searchData values in the incoming map. Called by the UI during rule creation. This method is responsible for validating and setting the data entered on the form from the UI of the routing report to the Rule's attribute. The values will be in a Map with the key being the key of the RuleExtensionValue and the value being the value of the data entered from the UI.

Parameters:

attributeName - name of the WorkflowRuleAttribute. cannot be null or blank.

paramMap - Map containing the names and values of the routing data for this Attribute

Returns:

ValidationResults. Will not return null.

Throws:

RiceIllegalArgumentException - if the attributeName is null or blank

RiceIllegalArgumentException - if the WorkflowRuleAttribute is not found

validateRuleData

ValidationResults validateRuleData(String attributeName,
                                   Map<String,String> paramMap)
                                   throws RiceIllegalArgumentException

Validates ruleExtension values in the incoming map. Called by the UI during rule creation. This method is responsible for validating and setting the data entered on the form from the UI of the rule creation to the Rule's attribute. The values will be in a Map with the key being the key of the RuleExtensionValue and the value being the value of the data entered from the UI. This method is used for rule creation which may have different fields than the routing report data.

Parameters:

attributeName - name of the WorkflowRuleAttribute. cannot be null or blank.

paramMap - Map containing the names and values of the routing data for this Attribute

Returns:

ValidationResults. Will not return null.

Throws:

RiceIllegalArgumentException - if the attributeName is null or blank

RiceIllegalArgumentException - if the WorkflowRuleAttribute is not found

getRoleNames

List<RoleName> getRoleNames(String attributeName)
                            throws RiceIllegalArgumentException

Gets a List of RoleName based on the passed role attribute name. This method loads loads up a RoleAttribute and determines the RoleNames for a RuleExtension

Parameters:

attributeName - name of the WorkflowRuleAttribute. cannot be null or blank.

Returns:

an immutable list of RoleName. Will not return null.

Throws:

RiceIllegalArgumentException - if the attributeName is null or blank

RiceIllegalArgumentException - if the RoleAttribute is not found