org.kuali.kfs.sys.document.datadictionary
Class TotalDefinition

java.lang.Object
  org.kuali.rice.kns.datadictionary.DataDictionaryDefinitionBase
      org.kuali.kfs.sys.document.datadictionary.TotalDefinition

All Implemented Interfaces:

Serializable, NestedFieldTotaling, org.kuali.rice.kns.datadictionary.DataDictionaryDefinition, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

AccountingLineGroupTotalDefinition, DebitCreditTotalDefinition

public abstract class TotalDefinition
extends org.kuali.rice.kns.datadictionary.DataDictionaryDefinitionBase
implements NestedFieldTotaling

Metadata about something that will be responsible for rendering some total of some accounting line group sometime, or something

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.kns.datadictionary.DataDictionaryDefinitionBase

id

Constructor Summary

TotalDefinition()

Method Summary

String	getActualPropertyName(String containingPropertyName, String propertyName) get the actual property name if the property is nested; otherwise, return the given property name
abstract Renderer	getTotalRenderer() Returns a renderer which will render the total for this total definition

Methods inherited from class org.kuali.rice.kns.datadictionary.DataDictionaryDefinitionBase

afterPropertiesSet, getId, setId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.kfs.sys.document.web.NestedFieldTotaling

isNestedProperty, setContainingPropertyName

Methods inherited from interface org.kuali.rice.kns.datadictionary.DataDictionaryDefinition

completeValidation

Constructor Detail

TotalDefinition

public TotalDefinition()

Method Detail

getTotalRenderer

public abstract Renderer getTotalRenderer()

Returns a renderer which will render the total for this total definition

Returns:

a Renderer which will render a total

getActualPropertyName

public String getActualPropertyName(String containingPropertyName,
                                    String propertyName)

get the actual property name if the property is nested; otherwise, return the given property name

Parameters:

containingPropertyName - the given containing property name

propertyName - the given peropety name

Returns:

the actual property name if the property is nested; otherwise, return the given property name