| edu.iu.uis.eden.plugin.attributes.RoleAttribute
All known Subclasses: org.kuali.workflow.attribute.KualiCGAttribute, org.kuali.workflow.attribute.KualiAccountAttribute, edu.iu.uis.eden.routetemplate.TestRuleAttributeThree, org.kuali.workflow.attribute.KualiVerificationWorkgroupAttribute, edu.iu.uis.eden.routetemplate.TestRuleAttribute, edu.iu.uis.eden.routetemplate.TestRuleAttributeDuex, org.kuali.workflow.attribute.KualiChartAttribute, edu.iu.uis.eden.routetemplate.GenericRoleAttribute, edu.iu.uis.eden.routetemplate.AbstractRoleAttribute,
RoleAttribute | public interface RoleAttribute (Code) | | A special type of attribute that is used exclusively for resolving abstract roles
to concrete responsibilities (users and groups). A RoleAttribute provides resolution
for a set of abstract "role" names. These are published via the
RoleAttribute.getRoleNames() method, which returns a list of
Role , which is a combination of class name (attribute implementation class),
abstract role name, and optional label and return url (DOCME: what is return url used for?).
RoleAttribute lifecycle:
- A RoleAttribute is defined on a Rule, via the
role element, with the syntax:
fully qualified class name!abstract role name. E.g.:
<role>edu.whatever.attribute.SomeAttribute!RoleName</role>
- When the
<role> element is parsed, the Rule's "responsibility" is set to the role element value
and the responsibility is marked to indicate that it is a role ("R",
EdenConstants.RULE_RESPONSIBILITY_ROLE_ID )
- When a Rule that is configured with a Role responsibility is fired,
RoleAttribute.getQualifiedRoleNames(String,DocumentContent) is called to return a list of "qualified" role names. Qualified role names are role names which have been qualified
with some relevant contextual information (e.g. from the document) that is useful for subsequent responsibility
resolution.
-
RoleAttribute.resolveQualifiedRole(RouteContext,String,String) is immediately called for each of the qualified role names
returned in the previous step, and it returns a
ResolvedQualifiedRole containing the
list of concrete recipients (
Id s).
- (
edu.iu.uis.eden.routetemplate.UnqualifiedRoleAttribute base class can be used to simplify this
two-step process)
Relationship to WorkflowAttribute: all RoleAttribute implementations are also
WorkflowAttribute implementations (is this true? should RoleAttribute extend WorkflowAttribute in that case?)
Methods of WorkflowAttribute interface fulfilled by RoleAttribute:
- ??
Methods of WorkflowAttribute interface not relevant to RoleAttribute:
-
WorkflowAttribute.isMatch(DocumentContentList)
- ??
See Also: WorkflowAttribute author: rkirkend |
getRoleNames | public List<Role> getRoleNames()(Code) | | List of
Role s this RoleAttribute supports
list of Roles this RoleAttribute supports |
|
|