Package org.kuali.rice.kns.workflow.attribute

Class DataDictionaryQualifierResolver

java.lang.Object
org.kuali.rice.kns.workflow.attribute.QualifierResolverBase
org.kuali.rice.kns.workflow.attribute.DataDictionaryQualifierResolver
All Implemented Interfaces:
QualifierResolver
@Deprecated public class DataDictionaryQualifierResolver extends QualifierResolverBase
Deprecated.
Only used by KNS classes, no replacement.
QualifierResolver which uses Data Dictionary defined workflow attributes to gather a collection of qualifiers to use to determine the responsibility for a document at a given workflow route node. WorkflowAttributes can be defined in the data dictionary like so (this has been abbreviated): <!-- Exported Workflow Attributes --> <bean id="DisbursementVoucherDocument-workflowAttributes" parent="DisbursementVoucherDocument-workflowAttributes-parentBean"/> <bean id="DisbursementVoucherDocument-workflowAttributes-parentBean" abstract="true" parent="WorkflowAttributes"> <property name="routingTypeDefinitions"> <map> <!-- no qualifiers for purchasing node --> <entry key="Account" value-ref="RoutingType-AccountingDocument-Account-sourceOnly"/> <entry key="AccountingOrganizationHierarchy" value-ref="RoutingType-AccountingDocument-OrganizationHierarchy-sourceOnly"/> <entry key="Campus" value-ref="DisbursementVoucherDocument-RoutingType-Campus"/> <!-- no qualifiers for tax review --> <!-- no qualifiers for travel review --> <entry key="PaymentMethod" value-ref="DisbursementVoucherDocument-RoutingType-PaymentMethod"/> <entry key="Award" value-ref="RoutingType-AccountingDocument-Award"/> </map> </property> </bean> <bean id="DisbursementVoucherDocument-RoutingType-PaymentMethod" class="org.kuali.rice.krad.datadictionary.RoutingTypeDefinition"> <property name="routingAttributes"> <list> <bean class="org.kuali.rice.krad.datadictionary.RoutingAttribute"> <property name="qualificationAttributeName" value="disbVchrPaymentMethodCode"/> </bean> </list> </property> <property name="documentValuePathGroups"> <list> <bean class="org.kuali.rice.krad.datadictionary.DocumentValuePathGroup"> <property name="documentValues"> <list> <value>disbVchrPaymentMethodCode</value> </list> </property> </bean> </list> </property> </bean> At the PaymentMethod node of the document, the DisbursementVoucherDocument-RoutingType-PaymentMethod RoutingTypeDefinition will be consulted; it will pull values from the document (in this case, document.disbVchrPaymentMethodCode) and populate those into the role qualifier Map<String, String>, with the key being the qualificationAttributeName and the value being the value of the property listed in the documentValuePathGroups in the document.

  • Constructor Details

    • DataDictionaryQualifierResolver

      public DataDictionaryQualifierResolver()
      Deprecated.

  • Method Details

    • resolve

      public List<Map<String,String>> resolve(RouteContext context)
      Deprecated.
      Given the RouteContext, determines the document type of the document being routed and the current route nodes; generates a List of qualifier Mapinvalid input: '<'String, String>s based on the the contents of the document.
      See Also:

    • getDocumentEntry

      protected org.kuali.rice.krad.datadictionary.DocumentEntry getDocumentEntry(RouteContext context)
      Deprecated.
      Retrieves the data dictionary entry for the document being operated on by the given route context
      Parameters:
      context - the current route context
      Returns:
      the data dictionary document entry

    • getWorkflowAttributeDefintion

      protected org.kuali.rice.krad.datadictionary.RoutingTypeDefinition getWorkflowAttributeDefintion(org.kuali.rice.krad.datadictionary.DocumentEntry documentEntry, String routeLevelName)
      Deprecated.
      Retrieves the proper List of WorkflowAttributes for the given route level from the data dictionary document entry
      Parameters:
      documentEntry - the data dictionary document entry for the currently routed document
      routeLevelName - the name of the route level
      Returns:
      a WorkflowAttributeDefinition if one could be found for the route level; otherwise, nothing

    • decorateWithCommonQualifiers

      protected void decorateWithCommonQualifiers(List<Map<String,String>> qualifiers, org.kuali.rice.krad.document.Document document, org.kuali.rice.krad.datadictionary.DocumentEntry documentEntry, String routeLevel)
      Deprecated.
      Add common qualifiers to every Mapinvalid input: '<'String, String> in the given List of Mapinvalid input: '<'String, String>
      Parameters:
      qualifiers - a List of Mapinvalid input: '<'String, String>s to add common qualifiers to
      document - the document currently being routed
      documentEntry - the data dictionary entry of the type of document currently being routed
      routeLevel - the document's current route level

    • addCommonQualifiersToMap

      protected void addCommonQualifiersToMap(Map<String,String> qualifier, org.kuali.rice.krad.document.Document document, org.kuali.rice.krad.datadictionary.DocumentEntry documentEntry, String routeLevel)
      Deprecated.
      Adds common qualifiers to a given Mapinvalid input: '<'String, String>
      Parameters:
      qualifier - an Mapinvalid input: '<'String, String> to add common qualifiers to
      document - the document currently being routed
      documentEntry - the data dictionary entry of the type of document currently being routed
      routeLevel - the document's current route level