org.kuali.rice.krad.workflow.attribute
Class QualifierResolverBase

java.lang.Object
  org.kuali.rice.krad.workflow.attribute.QualifierResolverBase

All Implemented Interfaces:

QualifierResolver

Direct Known Subclasses:

BookTypeQualifierResolver, DataDictionaryQualifierResolver, KimTypeQualifierResolver

public abstract class QualifierResolverBase
extends Object
implements QualifierResolver

This is a description of what this class does - kellerj don't forget to fill this in.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Field Summary

protected static String	KIM_ATTRIBUTE_DOCUMENT_NUMBER
protected static String	KIM_ATTRIBUTE_DOCUMENT_TYPE_NAME
protected static String	KIM_ATTRIBUTE_ROUTE_LEVEL_NAME

Constructor Summary

QualifierResolverBase()

Method Summary

protected void	addCommonQualifiersToMap(Map<String,String> qualifier, RouteContext context, String customDocTypeName) Adds common qualifiers to a given Map
protected void	decorateWithCommonQualifiers(List<Map<String,String>> qualifiers, RouteContext context, String customDocTypeName) Add common qualifiers to every Map in the given List of Map
protected Document	getDocument(RouteContext context) Retrieves the document that the current route context is operating on
protected String	getDocumentId(RouteContext context) Retrieves the id of the current document from the RouteContext
DocumentService	getDocumentService()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.kew.role.QualifierResolver

resolve

Field Detail

KIM_ATTRIBUTE_DOCUMENT_TYPE_NAME

protected static final String KIM_ATTRIBUTE_DOCUMENT_TYPE_NAME

See Also:

Constant Field Values

KIM_ATTRIBUTE_DOCUMENT_NUMBER

protected static final String KIM_ATTRIBUTE_DOCUMENT_NUMBER

See Also:

Constant Field Values

KIM_ATTRIBUTE_ROUTE_LEVEL_NAME

protected static final String KIM_ATTRIBUTE_ROUTE_LEVEL_NAME

See Also:

Constant Field Values

Constructor Detail

QualifierResolverBase

public QualifierResolverBase()

Method Detail

getDocument

protected Document getDocument(RouteContext context)

Retrieves the document that the current route context is operating on

Parameters:

context - the current route context

Returns:

the document

getDocumentId

protected String getDocumentId(RouteContext context)

Retrieves the id of the current document from the RouteContext

Parameters:

context - the current route context

Returns:

the id of the document

getDocumentService

public DocumentService getDocumentService()

decorateWithCommonQualifiers

protected void decorateWithCommonQualifiers(List<Map<String,String>> qualifiers,
                                            RouteContext context,
                                            String customDocTypeName)

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

Parameters:

qualifiers - a List of Maps 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,
                                        RouteContext context,
                                        String customDocTypeName)

Adds common qualifiers to a given Map

Parameters:

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