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

public class DataDictionaryQualifierResolver
extends QualifierResolverBase

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): disbVchrPaymentMethodCode 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 AttributeSet, with the key being the qualificationAttributeName and the value being the value of the property listed in the documentValuePathGroups in the document.

Field Summary

Fields inherited from class org.kuali.rice.kns.workflow.attribute.QualifierResolverBase

KIM_ATTRIBUTE_DOCUMENT_NUMBER, KIM_ATTRIBUTE_DOCUMENT_TYPE_NAME, KIM_ATTRIBUTE_ROUTE_LEVEL_NAME

Constructor Summary

DataDictionaryQualifierResolver()

Method Summary

protected void	addCommonQualifiersToAttributeSet(AttributeSet qualifier, Document document, DocumentEntry documentEntry, String routeLevel) Adds common qualifiers to a given AttributeSet
protected void	decorateWithCommonQualifiers(List<AttributeSet> qualifiers, Document document, DocumentEntry documentEntry, String routeLevel) Add common qualifiers to every AttributeSet in the given List of AttributeSet
protected DocumentEntry	getDocumentEntry(RouteContext context) Retrieves the data dictionary entry for the document being operated on by the given route context
protected RoutingTypeDefinition	getWorkflowAttributeDefintion(DocumentEntry documentEntry, String routeLevelName) Retrieves the proper List of WorkflowAttributes for the given route level from the data dictionary document entry
List<AttributeSet>	resolve(RouteContext context) Given the RouteContext, determines the document type of the document being routed and the current route nodes; generates a List of qualifier AttributeSets based on the the contents of the document.

Methods inherited from class org.kuali.rice.kns.workflow.attribute.QualifierResolverBase

addCommonQualifiersToAttributeSet, decorateWithCommonQualifiers, getDocument, getDocumentId, getDocumentService

Methods inherited from class java.lang.Object

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

Constructor Detail

DataDictionaryQualifierResolver

public DataDictionaryQualifierResolver()

Method Detail

resolve

public List<AttributeSet> resolve(RouteContext context)

Given the RouteContext, determines the document type of the document being routed and the current route nodes; generates a List of qualifier AttributeSets based on the the contents of the document.

See Also:

QualifierResolver.resolve(org.kuali.rice.kew.engine.RouteContext)

getDocumentEntry

protected DocumentEntry getDocumentEntry(RouteContext context)

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 RoutingTypeDefinition getWorkflowAttributeDefintion(DocumentEntry documentEntry,
                                                              String routeLevelName)

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<AttributeSet> qualifiers,
                                            Document document,
                                            DocumentEntry documentEntry,
                                            String routeLevel)

Add common qualifiers to every AttributeSet in the given List of AttributeSet

Parameters:

qualifiers - a List of AttributeSets 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

addCommonQualifiersToAttributeSet

protected void addCommonQualifiersToAttributeSet(AttributeSet qualifier,
                                                 Document document,
                                                 DocumentEntry documentEntry,
                                                 String routeLevel)

Adds common qualifiers to a given AttributeSet

Parameters:

qualifier - an AttributeSet 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