WorkflowRuleAttributeHandlerService

Name WorkflowRuleAttributeHandler
Version
Included Services  
Java Package org.kuali.rice.kew.framework.rule.attribute

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

Operations
Main Message Structures

Method getRuleFields
Description 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 Map parameters the parameters against which to validate
ExtensionDefinition extensionDefinition extension definition of the WorkflowRuleAttribute, cannot be null or blank.
boolean required the required flag which should be passed to the WorkflowRuleAttribute prior to processing
Return WorkflowRuleAttributeFields the WorkflowRuleAttributeFields, will not return null.
Errors RiceIllegalArgumentException if the extensionDefinition is null or blank

Back to Operations

Method getSearchFields
Description 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 Map parameters the parameters against which to validate
ExtensionDefinition extensionDefinition extension definition of the WorkflowRuleAttribute, cannot be null or blank.
boolean required the required flag which should be passed to the WorkflowRuleAttribute prior to processing
Return WorkflowRuleAttributeFields the WorkflowRuleAttributeFields, will not return null.
Errors RiceIllegalArgumentException if the extensionDefinition is null or blank

Back to Operations

Method getRoleNames
Description Gets a List of {@link RoleName} objects produced by the RoleAttribute defined by the given extension definition.
Parameters ExtensionDefinition extensionDefinition extension definition of the RoleAttribute, cannot be null or blank.
Return RoleNameList 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.
Errors RiceIllegalArgumentException if the extensionDefinition is null or blank

Back to Operations