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

java.lang.Object
  extended by org.kuali.rice.kns.datadictionary.DataDictionaryDefinitionBase
      extended by org.kuali.kfs.sys.document.datadictionary.TotalDefinition
          extended by org.kuali.kfs.sys.document.datadictionary.AccountingLineGroupTotalDefinition
All Implemented Interfaces:
Serializable, NestedFieldTotaling, org.kuali.rice.kns.datadictionary.DataDictionaryDefinition, org.springframework.beans.factory.InitializingBean
Direct Known Subclasses:
ProcurementCardGroupTotalDefinition

public class AccountingLineGroupTotalDefinition
extends TotalDefinition

The definition of an accounting line group total renderer, which will display an accounting line group total as a standard "Total: " + amount.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.kuali.rice.kns.datadictionary.DataDictionaryDefinitionBase
id
 
Constructor Summary
AccountingLineGroupTotalDefinition()
           
 
Method Summary
 void completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass)
          Validates that a total property has been added
 String getRepresentedProperty()
          Gets the representedProperty attribute.
 String getTotalLabelProperty()
          Gets the totalLabelProperty attribute.
 String getTotalProperty()
          Gets the totalProperty attribute.
 Renderer getTotalRenderer()
          Uses GroupTotalRenderer to render the total
 boolean isNestedProperty()
          determine whether the field for totaling is a nested property
 void setContainingPropertyName(String containingPropertyName)
          set the property name of the containing object if the field for totaling is a nested property
 void setNestedProperty(boolean nestedProperty)
          Sets the nestedProperty attribute value.
 void setRepresentedProperty(String representedProperty)
          Sets the representedProperty attribute value.
 void setTotalLabelProperty(String totalLabelProperty)
          Sets the totalLabelProperty attribute value.
 void setTotalProperty(String totalProperty)
          Sets the totalProperty attribute value.
 
Methods inherited from class org.kuali.kfs.sys.document.datadictionary.TotalDefinition
getActualPropertyName
 
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
 

Constructor Detail

AccountingLineGroupTotalDefinition

public AccountingLineGroupTotalDefinition()
Method Detail

getTotalProperty

public String getTotalProperty()
Gets the totalProperty attribute.

Returns:
Returns the totalProperty.

setTotalProperty

public void setTotalProperty(String totalProperty)
Sets the totalProperty attribute value.

Parameters:
totalProperty - The totalProperty to set.

getTotalLabelProperty

public String getTotalLabelProperty()
Gets the totalLabelProperty attribute.

Returns:
Returns the totalLabelProperty.

setTotalLabelProperty

public void setTotalLabelProperty(String totalLabelProperty)
Sets the totalLabelProperty attribute value.

Parameters:
totalLabelProperty - The totalLabelProperty to set.

getTotalRenderer

public Renderer getTotalRenderer()
Uses GroupTotalRenderer to render the total

Specified by:
getTotalRenderer in class TotalDefinition
Returns:
a Renderer which will render a total
See Also:
TotalDefinition.getTotalRenderer()

completeValidation

public void completeValidation(Class rootBusinessObjectClass,
                               Class otherBusinessObjectClass)
Validates that a total property has been added

See Also:
DataDictionaryDefinition.completeValidation(java.lang.Class, java.lang.Class)

getRepresentedProperty

public String getRepresentedProperty()
Gets the representedProperty attribute.

Returns:
Returns the representedProperty.

setRepresentedProperty

public void setRepresentedProperty(String representedProperty)
Sets the representedProperty attribute value.

Parameters:
representedProperty - The representedProperty to set.

isNestedProperty

public boolean isNestedProperty()
Description copied from interface: NestedFieldTotaling
determine whether the field for totaling is a nested property

Returns:
true if the field for totaling is a nested property; otherwise, false
See Also:
NestedFieldTotaling.isNestedProperty()

setNestedProperty

public void setNestedProperty(boolean nestedProperty)
Sets the nestedProperty attribute value.

Parameters:
nestedProperty - The nestedProperty to set.

setContainingPropertyName

public void setContainingPropertyName(String containingPropertyName)
Description copied from interface: NestedFieldTotaling
set the property name of the containing object if the field for totaling is a nested property

Parameters:
containingPropertyName - the given property name of the containing object
See Also:
NestedFieldTotaling.setContainingPropertyName(java.lang.String)


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.