Java Doc for WorkflowAttribute.java in  » ERP-CRM-Financial » Kuali-Financial-System » edu » iu » uis » eden » plugin » attributes » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Interface which abstracts a piece of information ("attribute") associated with a Workflow document, which can be used to make routing decisions when combined with Rules.

WorkflowAttribute lifecycle:

Definition via XML

1. Attribute definition is defined in XML (... any actions that are performed on-definition)
2. Attribute definition is registered in a Rule Template definition in XML
3. Rule Template is associated with a Document and a Rule in XML

Definition via UI (this documentation needs work)

1. ...?...
2. WorkflowAttribute.validateRuleData(Map) and WorkflowAttribute.validateRoutingData(Map) and are called to validate the configuration/extension values of the rule definition, and the user-configured rule data (??). see edu.iu.uis.eden.routetemplate.web.WebRuleBaseValues , edu.iu.uis.eden.routetemplate.RuleRoutingAttribute .
3. Not sure where and why these are called, or how that is reconciled with XML-based ingestion....? The 'required' field only seems to matter with regard to these two methods; it seems to only ever be used in implementations of these two methods

Runtime evaluation

1. Client application constructs edu.iu.uis.eden.clientapp.vo.WorkflowAttributeDefinitionVO and attaches it to the client-side document
2. Upon action taken on the document, the Attributes that are described by the WorkflowAttributeDefinitionVOs are looked up (... how ...) and constructed on the client side.
3. If the attribute is a WorkflowAttributeXmlValidator (e.g. edu.iu.uis.eden.routetemplate.xmlrouting.StandardGenericXMLRuleAttribute ), then WorkflowAttributeXmlValidator.validateClientRoutingData is called to validate any data the client app may have set on the client-instantiated attribute (the edu.iu.uis.eden.clientapp.vo.WorkflowAttributeDefinitionVO )
4. Attribute content (content the attribute generates to place in the eDoc document content) is obtained from the attribute via WorkflowAttribute.getDocContent or edu.iu.uis.eden.docsearch.SearchableAttribute.getSearchContent , depending on whether the attribute is a WorkflowAttribute or edu.iu.uis.eden.docsearch.SearchableAttribute
5. When a Rule is invoked (for instance, when a requests node is fired), all attributes associated with the rule (those associated with the Rule Template associated with the rule) which are WorkflowAttributes are enumerated and for each:
   1. A special case is made for attributes defined in XML as of "RuleXmlAttribute" type ( EdenConstants.RULE_XML_ATTRIBUTE_TYPE ): the attribute is cast to GenericXMLRuleAttribute and RuleAttribute business object is set on it ( GenericXMLRuleAttribute.setRuleAttribute(edu.iu.uis.eden.routetemplate.RuleAttribute) before proceeding with isMatch invocation. (what about a RuleAttributeAware interface so this can be done generically for all worklfow attribute implementations?)
   2. WorkflowAttribute.isMatch(DocumentContentList) is called with the Rule's extension values passed
6. If all attributes for the rule match, the rule is fired

A single Row may contain more than one actual Field instance, but Fields beyond the first one are there to provide context for the display and evaluation of the first one. The getRuleRows method returns a list of rows that contain Fields describing the UI-level presentation of a single RuleExtensionValue for the creation of a rule. A single row may contain more than one actual Field object, but Fields beyond the first one are there to provide context for the display and evaluation of the first one. For example, a secondary field may be a lookupable or a searchable valid values object.

For example, DollarRangeAttribute returns a single tag containing its totalDollarAmount, thus:

 <totalDollarAmount>345</totalDollarAmount>
 

For example, the DollarRangeAttribute has two associated RuleExtensionValues - its minimum and maximum values - which control when a rule containing that attribute gets evaluated.

The UI instantiates a Rule from a RuleTemplate, uses the RuleRows of all of that Rule's Attributes to build a form, uses user input to create a set of RuleExtensionValues which get persisted when the rule is persisted. To create a RuleExtensionValue object, instantiate a new object, set the key which will be located on the Rule's attribute, set the value which will be entered on the form from the UI side, and finally add each RuleExtensionValue object to a list. (Basically, given a configured/initialized attribute, marshalls out the RuleExtensionValues representing the current state of the attribute - Aaron Hamid FIXME)

A single Row may contain more than one actual Field instance, but Fields beyond the first one are there to provide context for the display and evaluation of the first one. The getRuleRows method returns a list of rows that contain Fields describing the UI-level presentation of a single RuleExtensionValue for the creation of a rule. A single row may contain more than one actual Field object, but Fields beyond the first one are there to provide context for the display and evaluation of the first one. For example, a secondary field may be a lookupable or a searchable valid values object. An individual field consists of a field label, a field help url, a field type, whether a lookupable is associated with this field, a property name, a property value, valid values, the name of the lookupable, and the default lookupable name for this field. The field label is a short title that will display on the jsp describing what data to enter for this field. The field help url is optional, but will pop open in a new window the url entered. The field type is the type of field to display (e.g. hidden, text, drop down, radio, quickfinder (lookupable), lookup result only (this type is needed for the lookupable, but does not actually render on the jsp), and finally drop down refresh (this type is a drop down box that when it's value changes another drop down box's valid values will be changed as well)). The lookupable indicator determines whether this field will have a lookupable (valid value search) associated with it. The property name is the name of the field when rendered on the jsp. This needs to be unique when compared to other field names on the jsp. The property value is the value entered into the text box or other field type on the jsp. This value will be empty when creating the field and populated during form submission. A List of valid values is optional and needed to populate drop down boxes or radio buttons. This list consists of KeyLabelPair objects which the key will be the value passed in on submission and the label will be what is display on the jsp. The lookupable is the name of the lookable service to be called for this field. The default lookupable name is the name of the field on the lookupable itself. This may be the same of the property name of the field. This is needed when field conversions are needed. If the lookupable returns a key that doesn't match a property name on the jsp it needs to be converted to one that does. So if the property name is different than the default lookupable name, the lookupable will convert the return key to the property name of the field. Example: say by default a lookupable returns "color=red" on the url. The default lookupable name would be "color" and if you needed a different name for this property on the jsp such as "wallcolor", the lookupable will now return "wallcolor=red" instead of the default "color=red". The default lookupable name also is the key for rule extension values. When an extension value is saved the value comes from the UI and the key from this field. If this field is left null, then the property name of the field will become the key stored in the database for the extension value. A row can also consist of a group label and number of rows for this label to span for this attribute. If a group label is present, it will display on the rule creation jsp and group together the individual rows for this attribute. The total rows number will rowspan the group label across the rows of this attribute. NOTE: the group label and number of rows to span must be specified on each row object for the display to work correctly.