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

Modifier and Type	Method and Description
List<RoleName>	getRoleNames(ExtensionDefinition extensionDefinition) Gets a List of RoleName objects produced by the RoleAttribute defined by the given extension definition.
WorkflowRuleAttributeFields	getRoutingDataFields(Map<String,String> parameters, ExtensionDefinition extensionDefinition, boolean required) Using the WorkflowRuleAttribute defined by the given extension definition, does the following: validates the given rule attribute parameters, fetches the list of RemotableAttributeField objects to display for rule reporting then determines the rule extension values produced by the attribute and returns this information as a WorkflowRuleAttributeFields object.
WorkflowRuleAttributeFields	getRuleFields(Map<String,String> parameters, ExtensionDefinition extensionDefinition, boolean required) Using the WorkflowRuleAttribute defined by the given extension definition, does the following: validates the given rule attribute parameters, fetches the list of RemotableAttributeField objects to display for the rule, and then determines the rule extension values produced by the attribute and returns this information as a WorkflowRuleAttributeFields object.
WorkflowRuleAttributeFields	getSearchFields(Map<String,String> parameters, ExtensionDefinition extensionDefinition, boolean required) Using the WorkflowRuleAttribute defined by the given extension definition, does the following: validates the given rule attribute parameters, fetches the list of RemotableAttributeField objects to display for the rule search, and then determines the rule extension values produced by the attribute and returns this information as a WorkflowRuleAttributeFields object.

Method Detail

getRuleFields

WorkflowRuleAttributeFields getRuleFields(Map<String,String> parameters,
                                          ExtensionDefinition extensionDefinition,
                                          boolean required)
                                   throws RiceIllegalArgumentException

Using the WorkflowRuleAttribute defined by the given extension definition, does the following: validates the given rule attribute parameters, fetches the list of RemotableAttributeField objects to display for the rule, and then determines the rule extension values produced by the attribute and returns this information as a WorkflowRuleAttributeFields object.

Parameters:

parameters - the parameters against which to validate

extensionDefinition - extension definition of the WorkflowRuleAttribute, cannot be null or blank.

required - the required flag which should be passed to the WorkflowRuleAttribute prior to processing

Returns:

the WorkflowRuleAttributeFields, will not return null.

Throws:

RiceIllegalArgumentException - if the extensionDefinition is null or blank

RiceIllegalArgumentException - if the WorkflowRuleAttribute is not found

getSearchFields

WorkflowRuleAttributeFields getSearchFields(Map<String,String> parameters,
                                            ExtensionDefinition extensionDefinition,
                                            boolean required)
                                     throws RiceIllegalArgumentException

Using the WorkflowRuleAttribute defined by the given extension definition, does the following: validates the given rule attribute parameters, fetches the list of RemotableAttributeField objects to display for the rule search, and then determines the rule extension values produced by the attribute and returns this information as a WorkflowRuleAttributeFields object.

Parameters:

parameters - the parameters against which to validate

extensionDefinition - extension definition of the WorkflowRuleAttribute, cannot be null or blank.

required - the required flag which should be passed to the WorkflowRuleAttribute prior to processing

Returns:

the WorkflowRuleAttributeFields, will not return null.

Throws:

RiceIllegalArgumentException - if the extensionDefinition is null or blank

RiceIllegalArgumentException - if the WorkflowRuleAttribute is not found

getRoutingDataFields

WorkflowRuleAttributeFields getRoutingDataFields(Map<String,String> parameters,
                                                 ExtensionDefinition extensionDefinition,
                                                 boolean required)
                                          throws RiceIllegalArgumentException

Using the WorkflowRuleAttribute defined by the given extension definition, does the following: validates the given rule attribute parameters, fetches the list of RemotableAttributeField objects to display for rule reporting then determines the rule extension values produced by the attribute and returns this information as a WorkflowRuleAttributeFields object.

Parameters:

parameters - the parameters against which to validate

extensionDefinition - extension definition of the WorkflowRuleAttribute, cannot be null or blank.

required - the required flag which should be passed to the WorkflowRuleAttribute prior to processing

Returns:

the WorkflowRuleAttributeFields, will not return null.

Throws:

RiceIllegalArgumentException - if the extensionDefinition is null or blank

RiceIllegalArgumentException - if the WorkflowRuleAttribute is not found

getRoleNames

List<RoleName> getRoleNames(ExtensionDefinition extensionDefinition)
                     throws RiceIllegalArgumentException

Gets a List of RoleName objects produced by the RoleAttribute defined by the given extension definition.

Parameters:

extensionDefinition - extension definition of the RoleAttribute, cannot be null or blank.

Returns:

an immutable list of RoleName objects, if none are defined or the supplied extension definition is not an instance of RoleAttribute, this will return an empty list. This method will never return null.

Throws:

RiceIllegalArgumentException - if the extensionDefinition is null or blank

RiceIllegalArgumentException - if the RoleAttribute is not found