Package org.kuali.rice.ken.kew

Class ChannelReviewerRoleAttribute

java.lang.Object
org.kuali.rice.kew.rule.AbstractWorkflowAttribute
org.kuali.rice.kew.rule.GenericWorkflowAttribute
org.kuali.rice.kew.rule.GenericRoleAttribute
org.kuali.rice.ken.kew.ChannelReviewerRoleAttribute
All Implemented Interfaces:
Serializable, RoleAttribute, WorkflowRuleAttribute
public class ChannelReviewerRoleAttribute extends GenericRoleAttribute
KEW RoleAttribute implementation that is responsible for encapsulating a list of users and groups which are reviewers for a Notification Channel. This implementation relies on the default XML form implemented by GenericRoleAttribute
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Constructor Details

    • ChannelReviewerRoleAttribute

      public ChannelReviewerRoleAttribute()

  • Method Details

    • 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
      Overrides:
      isMatch in class GenericRoleAttribute

    • getProperties

      public Map<String,String> getProperties()
      Description copied from class: GenericWorkflowAttribute
      Template method for subclasses to override to expose attribute state
      Specified by:
      getProperties in class GenericWorkflowAttribute
      Returns:
      map exposing attribute state

    • getRoleNames

      public List<RoleName> getRoleNames()
      Description copied from interface: RoleAttribute
      List of RoleNames this RoleAttribute supports
      Returns:
      list of RoleNames this RoleAttribute supports

    • getQualifiedRoleNames

      public List<String> getQualifiedRoleNames(String roleName, DocumentContent documentContent)
      Description copied from interface: RoleAttribute
      Returns a String which represent the qualified role name of this role for the given roleName and docContent.
      Specified by:
      getQualifiedRoleNames in interface RoleAttribute
      Overrides:
      getQualifiedRoleNames in class GenericRoleAttribute
      Parameters:
      roleName - the role name (without class prefix)
      documentContent - the document content

    • resolveRecipients

      protected List<Id> resolveRecipients(RouteContext routeContext, QualifiedRoleName qualifiedRoleName)
      This looks at the reviewers list passed through from KEN and then resolves the individuals that need to actually approve the message.
      Overrides:
      resolveRecipients in class GenericRoleAttribute
      See Also: