Package org.kuali.rice.kew.rule

Class WorkflowRuleAttributeMediatorImpl

java.lang.Object
org.kuali.rice.kew.rule.WorkflowRuleAttributeMediatorImpl
All Implemented Interfaces:
WorkflowRuleAttributeMediator
public class WorkflowRuleAttributeMediatorImpl extends Object implements WorkflowRuleAttributeMediator
Reference implementation of WorkflowRuleAttributeMediator.
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Constructor Details

    • WorkflowRuleAttributeMediatorImpl

      public WorkflowRuleAttributeMediatorImpl()

  • Method Details

    • getRuleRows

      public WorkflowRuleAttributeRows getRuleRows(Map<String,String> parameters, RuleTemplateAttributeBo ruleTemplateAttribute)
      Description copied from interface: WorkflowRuleAttributeMediator
      Equivalent to WorkflowRuleAttributeMediator.getRuleRows(java.util.Map, org.kuali.rice.kew.rule.bo.RuleTemplateAttributeBo) but takes a RuleTemplateAttributeBo instead of a RuleTemplateAttribute. Exists primarily for convenience of the calling code.
      Specified by:
      getRuleRows in interface WorkflowRuleAttributeMediator

    • getRuleRows

      public WorkflowRuleAttributeRows getRuleRows(Map<String,String> parameters, RuleTemplateAttribute ruleTemplateAttribute)
      Description copied from interface: WorkflowRuleAttributeMediator
      Returns rule row configuration for the workflow rule attribute defined on the given RuleTemplateAttribute. These are the rows which show up on the rule and rule delegation maintenance screen when creating or editing a rule or rule delegation which uses the given attribute, as well as on the inquiry for the rule.

      Will use the supplied parameters to populate the WorkflowRuleAttribute by running the validateRuleData method on that attribute. The result of this call contains any validation errors, the Row objects as constructed by the attribute, and the final values for the rule extensions after validation and processing has been executed.

      Specified by:
      getRuleRows in interface WorkflowRuleAttributeMediator
      Parameters:
      parameters - a map of parameters to pass to the backend WorkflowRuleAttribute for validation, may be null or an empty map
      ruleTemplateAttribute - the RuleTemplateAttribute which defines the ExtensionDefinition for the WorkflowRuleAttribute against which to validate and retrieve the rows, as well as the required flag which should be passed to the attribute
      Returns:
      the result of validating and retrieving rule rows, will never return null

    • getRoutingDataRows

      public WorkflowRuleAttributeRows getRoutingDataRows(Map<String,String> parameters, RuleTemplateAttributeBo ruleTemplateAttribute)
      Description copied from interface: WorkflowRuleAttributeMediator
      Equivalent to WorkflowRuleAttributeMediator.getRoutingDataRows(java.util.Map, org.kuali.rice.kew.rule.bo.RuleTemplateAttributeBo) but takes a RuleTemplateAttributeBo instead of a RuleTemplateAttribute. Exists primarily for convenience of the calling code.
      Specified by:
      getRoutingDataRows in interface WorkflowRuleAttributeMediator

    • getRoutingDataRows

      public WorkflowRuleAttributeRows getRoutingDataRows(Map<String,String> parameters, RuleTemplateAttribute ruleTemplateAttribute)
      Description copied from interface: WorkflowRuleAttributeMediator
      Returns rule attribute row configuration for the workflow rule attribute defined on the given RuleTemplateAttribute. These are the rows which show up on the Routing Report screen when using a RuleTemplate which includes the given RuleTemplateAttribute.

      Will use the supplied parameters to populate the WorkflowRuleAttribute by running the validateRoutingData method on that attribute. The result of this call contains any validation errors, the Row objects as constructed by the attribute, and the final values for the rule extensions after validation and processing has been executed.

      Specified by:
      getRoutingDataRows in interface WorkflowRuleAttributeMediator
      Parameters:
      parameters - a map of parameters to pass to the backend WorkflowRuleAttribute for validation, may be null or an empty map
      ruleTemplateAttribute - the RuleTemplateAttribute which defines the ExtensionDefinition for the WorkflowRuleAttribute against which to validate and retrieve the search rows, as well as the required flag which should be passed to the attribute
      Returns:
      the result of validating and retrieving rule search rows, will never return null

    • getSearchRows

      public WorkflowRuleAttributeRows getSearchRows(Map<String,String> parameters, RuleTemplateAttribute ruleTemplateAttribute)
      Description copied from interface: WorkflowRuleAttributeMediator
      Returns rule search row configuration for the workflow rule attribute defined on the given RuleTemplateAttribute. These are the rows which show up on the rule and rule delegation lookup screen when searching for rules or rule delegations using a RuleTemplate which includes the given RuleTemplateAttribute.

      Will use the supplied parameters to populate the WorkflowRuleAttribute by running the validateRuleData method on that attribute (or if the attribute implements WorkflowRuleSearchAttribute, will execute validateSearchData). The result of this call contains any validation errors, the Row objects as constructed by the attribute, and the final values for the rule extensions after validation and processing has been executed.

      Specified by:
      getSearchRows in interface WorkflowRuleAttributeMediator
      Parameters:
      parameters - a map of parameters to pass to the backend WorkflowRuleAttribute for validation, may be null or an empty map
      ruleTemplateAttribute - the RuleTemplateAttribute which defines the ExtensionDefinition for the WorkflowRuleAttribute against which to validate and retrieve the search rows, as well as the required flag which should be passed to the attribute
      Returns:
      the result of validating and retrieving rule search rows, will never return null

    • getSearchRows

      public WorkflowRuleAttributeRows getSearchRows(Map<String,String> parameters, RuleTemplateAttribute ruleTemplateAttribute, boolean required)
      Description copied from interface: WorkflowRuleAttributeMediator
      Equivalent to call WorkflowRuleAttributeMediator.getSearchRows(java.util.Map, org.kuali.rice.kew.api.rule.RuleTemplateAttribute) but passes a custom value for the required flag that is passed to the attribute instead of using the one defined by the given RuleTemplateAttribute.isRequired(). The main use case for this is in the case of a lookup where it's desirable to disable required validation for search fields that have not been filled in (in that case a value of "false" would be passed as the last argument to this method).
      Specified by:
      getSearchRows in interface WorkflowRuleAttributeMediator

    • getRoleNames

      public List<RoleName> getRoleNames(RuleTemplateAttributeBo ruleTemplateAttribute)
      Description copied from interface: WorkflowRuleAttributeMediator
      Returns the list of role names as defined on the RoleAttribute defined by the given rule template attribute. In this case that the defined rule template attribute does not represent a role attribute or does not return any role names, this method will return an empty list.
      Specified by:
      getRoleNames in interface WorkflowRuleAttributeMediator
      Parameters:
      ruleTemplateAttribute - the RuleTemplateAttribute which defines the ExtensionDefinition for the RoleAttribute from which to fetch the role names

    • getHandler

      protected org.kuali.rice.kew.framework.rule.attribute.WorkflowRuleAttributeHandlerService getHandler(ExtensionDefinition extensionDefinition)
      Retrieves the WorkflowRuleAttributeHandlerService which can be used to handle the given ExtensionDefinition. If such a service cannot be loaded, an IllegalStateException is thrown.
      Parameters:
      extensionDefinition - the definition of the extension which will be accessed through the handler service
      Returns:
      a reference to a handler service which can be used to interact with the given extension definition
      Throws:
      IllegalStateException - if the handler cannot be found