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

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.DebitCreditTotalDefinition
All Implemented Interfaces:
Serializable, NestedFieldTotaling, org.kuali.rice.kns.datadictionary.DataDictionaryDefinition, org.springframework.beans.factory.InitializingBean

public class DebitCreditTotalDefinition
extends TotalDefinition

Metadata that instructs the accounting line tags how to render debit/credit totals used in voucher documents

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.kuali.rice.kns.datadictionary.DataDictionaryDefinitionBase
id
 
Constructor Summary
DebitCreditTotalDefinition()
           
 
Method Summary
 void completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass)
          Validates that total properties have been added
 String getCreditTotalLabelProperty()
          Gets the creditTotalLabelProperty attribute.
 String getCreditTotalProperty()
          Gets the creditTotalProperty attribute.
 String getDebitTotalLabelProperty()
          Gets the debitTotalLabelProperty attribute.
 String getDebitTotalProperty()
          Gets the debitTotalProperty attribute.
 String getRepresentedProperty()
          Gets the representedProperty attribute.
 Renderer getTotalRenderer()
          Returns a renderer which will render the total for this total definition
 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 setCreditTotalLabelProperty(String creditTotalLabelProperty)
          Sets the creditTotalLabelProperty attribute value.
 void setCreditTotalProperty(String creditTotalProperty)
          Sets the creditTotalProperty attribute value.
 void setDebitTotalLabelProperty(String debitTotalLabelProperty)
          Sets the debitTotalLabelProperty attribute value.
 void setDebitTotalProperty(String debitTotalProperty)
          Sets the debitTotalProperty attribute value.
 void setNestedProperty(boolean nestedProperty)
          Sets the nestedProperty attribute value.
 void setRepresentedProperty(String representedProperty)
          Sets the representedProperty 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

DebitCreditTotalDefinition

public DebitCreditTotalDefinition()
Method Detail

getTotalRenderer

public Renderer getTotalRenderer()
Description copied from class: TotalDefinition
Returns a renderer which will render the total for this total definition

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 total properties have been added

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

getDebitTotalProperty

public String getDebitTotalProperty()
Gets the debitTotalProperty attribute.

Returns:
Returns the debitTotalProperty.

setDebitTotalProperty

public void setDebitTotalProperty(String debitTotalProperty)
Sets the debitTotalProperty attribute value.

Parameters:
debitTotalProperty - The debitTotalProperty to set.

getCreditTotalProperty

public String getCreditTotalProperty()
Gets the creditTotalProperty attribute.

Returns:
Returns the creditTotalProperty.

setCreditTotalProperty

public void setCreditTotalProperty(String creditTotalProperty)
Sets the creditTotalProperty attribute value.

Parameters:
creditTotalProperty - The creditTotalProperty to set.

getDebitTotalLabelProperty

public String getDebitTotalLabelProperty()
Gets the debitTotalLabelProperty attribute.

Returns:
Returns the debitTotalLabelProperty.

setDebitTotalLabelProperty

public void setDebitTotalLabelProperty(String debitTotalLabelProperty)
Sets the debitTotalLabelProperty attribute value.

Parameters:
debitTotalLabelProperty - The debitTotalLabelProperty to set.

getCreditTotalLabelProperty

public String getCreditTotalLabelProperty()
Gets the creditTotalLabelProperty attribute.

Returns:
Returns the creditTotalLabelProperty.

setCreditTotalLabelProperty

public void setCreditTotalLabelProperty(String creditTotalLabelProperty)
Sets the creditTotalLabelProperty attribute value.

Parameters:
creditTotalLabelProperty - The creditTotalLabelProperty to set.

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.

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)

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()


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