org.kuali.rice.kew.rule
Class AbstractRoleAttribute

java.lang.Object
  org.kuali.rice.kew.rule.AbstractWorkflowAttribute
      org.kuali.rice.kew.rule.AbstractRoleAttribute

All Implemented Interfaces:

Serializable, RoleAttribute, WorkflowRuleAttribute

Direct Known Subclasses:

AbstractIdRoleAttribute, AccountAttribute, UnqualifiedRoleAttribute

public abstract class AbstractRoleAttribute
extends AbstractWorkflowAttribute
implements RoleAttribute

Abstract base class for RoleAttributes.

Author:

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

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.kew.rule.AbstractWorkflowAttribute

required

Constructor Summary

AbstractRoleAttribute()

Method Summary

boolean

isMatch(DocumentContent docContent, List<RuleExtension> ruleExtensions) Returns true if this Attribute finds a match in the given DocContent.

Methods inherited from class org.kuali.rice.kew.rule.AbstractWorkflowAttribute

getDocContent, getIdFieldName, getLockFieldName, getRoutingDataRows, getRuleExtensionValues, getRuleRows, isRequired, setRequired, validateRoutingData, validateRuleData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.kuali.rice.kew.rule.RoleAttribute

getQualifiedRoleNames, getRoleNames, resolveQualifiedRole

Methods inherited from interface org.kuali.rice.kew.rule.WorkflowRuleAttribute

getDocContent, getRoutingDataRows, getRuleExtensionValues, getRuleRows, isRequired, setRequired, validateRoutingData, validateRuleData

Constructor Detail

AbstractRoleAttribute

public AbstractRoleAttribute()

Method Detail

isMatch

public boolean isMatch(DocumentContent docContent,
                       List<RuleExtension> ruleExtensions)

Description copied from interface: WorkflowRuleAttribute

Returns true if this Attribute finds a match in the given DocContent. If true, the associated document will be routed to the users specifed by the UNF The isMatch method is responsible for determining whether content in a document matches content saved in workflow, thus determining whether to fire a rule or not. The isMatch method takes a DocumentContent object and a list of rule extension objects and returns a Boolean. The DocumentContent object contains the data in XML format that will be compared with the rules saved in workflow. Rule extension objects come from a potential rule that may match the document content on this eDoc. The potential rule is selected based on the Document Type and Rule Templates associated with this eDoc. Each rule extension object contains a list of rule extension value objects which have the data we will use in key value format to compare to the document content. The key will be determined by a unique string assigned by this attribute. The Value is determined when a rule is created and data is entered for the particular key. If a match is found, this method returns true and the eDoc will be routed based on this rule. If no match is found, the method returns false and the eDoc will not be routed based on this rule.

Specified by:

isMatch in interface WorkflowRuleAttribute