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

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

All Implemented Interfaces:

QualifierResolver

Direct Known Subclasses:

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

private static DocumentService	documentService
protected static String	KIM_ATTRIBUTE_DOCUMENT_NUMBER
protected static String	KIM_ATTRIBUTE_DOCUMENT_TYPE_NAME
protected static String	KIM_ATTRIBUTE_ROUTE_LEVEL_NAME
private static org.apache.log4j.Logger	LOG

Constructor Summary

QualifierResolverBase()

Method Summary

protected void	addCommonQualifiersToAttributeSet(AttributeSet qualifier, RouteContext context, String customDocTypeName) Adds common qualifiers to a given AttributeSet
protected void	decorateWithCommonQualifiers(List<AttributeSet> qualifiers, RouteContext context, String customDocTypeName) Add common qualifiers to every AttributeSet in the given List of AttributeSet
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

LOG

private static org.apache.log4j.Logger LOG

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

documentService

private static DocumentService documentService

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<AttributeSet> qualifiers,
                                            RouteContext context,
                                            String customDocTypeName)

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,
                                                 RouteContext context,
                                                 String customDocTypeName)

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