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

java.lang.Object
  org.kuali.rice.kns.datadictionary.DataDictionaryDefinitionBase
      org.kuali.rice.kns.datadictionary.MaintainableItemDefinition
          org.kuali.rice.kns.datadictionary.MaintainableFieldDefinition
              org.kuali.kfs.sys.document.datadictionary.AccountingLineViewDebitCreditAmountFieldDefinition

All Implemented Interfaces:

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

public class AccountingLineViewDebitCreditAmountFieldDefinition
extends org.kuali.rice.kns.datadictionary.MaintainableFieldDefinition
implements AccountingLineViewRenderableElementDefinition

Data dictionary meta data that represents a debit/credit amount field. By default, it expects the new line debit amount property on the form to be called "newSourceLineDebit", the debit amount on a new line to be called "newSourceLineCredit", and for the form to have a collection VoucherAccountingLineHelper implementation objects called "voucherLineHelpers", though these can be overridden.

See Also:

Serialized Form

Field Summary

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

additionalDisplayAttributeName, alternateDisplayAttributeName, defaultValue, defaultValueFinderClass, fieldLevelHelpUrl, lookupReadOnly, noLookup, overrideFieldConversions, overrideLookupClass, readOnlyAfterAdd, required, showFieldLevelHelp, template, triggerOnChange, unconditionallyReadOnly, webUILeaveFieldCallbackFunction, webUILeaveFieldFunction, webUILeaveFieldFunctionParameters

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

id

Constructor Summary

AccountingLineViewDebitCreditAmountFieldDefinition()

Method Summary

protected AccountingLineViewFieldDefinition	createFieldDefinitionForProperty(String propertyName) Creates an AccountingLineViewFieldDefinition for the given property name
protected org.kuali.rice.kns.web.ui.Field	createFieldForPropertyName(String propertyName, Class<? extends AccountingLine> accountingLineClass) Creates a field for the given AccountingLine class and property name
TableJoining	createLayoutElement(Class<? extends AccountingLine> accountingLineClass) Returns the TableJoining element that this definition requires to be part of the accounting line view
String	getAmountFieldName() Gets the amountFieldName attribute.
String	getNewLineCreditAmountProperty() Gets the newLineCreditAmountProperty attribute.
String	getNewLineDebitAmountProperty() Gets the newLineDebitAmountProperty attribute.
String	getVoucherLineHelperProperty() Gets the voucherLineHelpersProperty attribute.
void	setAmountFieldName(String amountFieldName) Sets the amountFieldName attribute value.
void	setNewLineCreditAmountProperty(String newLineCreditAmountProperty) Sets the newLineCreditAmountProperty attribute value.
void	setNewLineDebitAmountProperty(String newLineDebitAmountProperty) Sets the newLineDebitAmountProperty attribute value.
void	setUseShortLabels(boolean useShortLabels) Sets the useShortLabels attribute value.
void	setVoucherLineHelperProperty(String voucherLineHelpersProperty) Sets the voucherLineHelpersProperty attribute value.
boolean	shouldUseShortLabels() Gets the useShortLabels attribute.

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

completeValidation, getAdditionalDisplayAttributeName, getAlternateDisplayAttributeName, getDefaultValue, getDefaultValueFinderClass, getFieldLevelHelpUrl, getOverrideFieldConversions, getOverrideLookupClass, getTemplate, getWebUILeaveFieldCallbackFunction, getWebUILeaveFieldFunction, getWebUILeaveFieldFunctionParameters, isLookupReadOnly, isNoLookup, isReadOnlyAfterAdd, isRequired, isShowFieldLevelHelp, isTriggerOnChange, isUnconditionallyReadOnly, setAdditionalDisplayAttributeName, setAlternateDisplayAttributeName, setDefaultValue, setDefaultValueFinderClass, setFieldLevelHelpUrl, setLookupReadOnly, setNoLookup, setOverrideFieldConversions, setOverrideLookupClass, setReadOnlyAfterAdd, setRequired, setShowFieldLevelHelp, setTemplate, setTriggerOnChange, setUnconditionallyReadOnly, setWebUILeaveFieldCallbackFunction, setWebUILeaveFieldFunction, setWebUILeaveFieldFunctionParameters, toString

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

getName, setName

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, wait, wait, wait

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

getName

Constructor Detail

AccountingLineViewDebitCreditAmountFieldDefinition

public AccountingLineViewDebitCreditAmountFieldDefinition()

Method Detail

createLayoutElement

public TableJoining createLayoutElement(Class<? extends AccountingLine> accountingLineClass)

Description copied from interface: AccountingLineViewRenderableElementDefinition

Returns the TableJoining element that this definition requires to be part of the accounting line view

Specified by:

createLayoutElement in interface AccountingLineViewRenderableElementDefinition

Returns:

a properly created TableJoining element

See Also:

AccountingLineViewRenderableElementDefinition.createLayoutElement(java.lang.Class)

createFieldForPropertyName

protected org.kuali.rice.kns.web.ui.Field createFieldForPropertyName(String propertyName,
                                                                     Class<? extends AccountingLine> accountingLineClass)

Creates a field for the given AccountingLine class and property name

Parameters:

propertyName - the name of the property to create a Field for

accountingLineClass - the Class of the AccountingLine we're planning on rendering

Returns:

an appropriately created Field

createFieldDefinitionForProperty

protected AccountingLineViewFieldDefinition createFieldDefinitionForProperty(String propertyName)

Creates an AccountingLineViewFieldDefinition for the given property name

Parameters:

propertyName - the name of the field property that we're creating a definition for

Returns:

an appropriately created AccountingLineViewFieldDefinition

getNewLineCreditAmountProperty

public String getNewLineCreditAmountProperty()

Gets the newLineCreditAmountProperty attribute.

Returns:

Returns the newLineCreditAmountProperty.

setNewLineCreditAmountProperty

public void setNewLineCreditAmountProperty(String newLineCreditAmountProperty)

Sets the newLineCreditAmountProperty attribute value.

Parameters:

newLineCreditAmountProperty - The newLineCreditAmountProperty to set.

getNewLineDebitAmountProperty

public String getNewLineDebitAmountProperty()

Gets the newLineDebitAmountProperty attribute.

Returns:

Returns the newLineDebitAmountProperty.

setNewLineDebitAmountProperty

public void setNewLineDebitAmountProperty(String newLineDebitAmountProperty)

Sets the newLineDebitAmountProperty attribute value.

Parameters:

newLineDebitAmountProperty - The newLineDebitAmountProperty to set.

getVoucherLineHelperProperty

public String getVoucherLineHelperProperty()

Gets the voucherLineHelpersProperty attribute.

Returns:

Returns the voucherLineHelpersProperty.

setVoucherLineHelperProperty

public void setVoucherLineHelperProperty(String voucherLineHelpersProperty)

Sets the voucherLineHelpersProperty attribute value.

Parameters:

voucherLineHelpersProperty - The voucherLineHelpersProperty to set.

shouldUseShortLabels

public boolean shouldUseShortLabels()

Gets the useShortLabels attribute.

Returns:

Returns the useShortLabels.

setUseShortLabels

public void setUseShortLabels(boolean useShortLabels)

Sets the useShortLabels attribute value.

Parameters:

useShortLabels - The useShortLabels to set.

getAmountFieldName

public String getAmountFieldName()

Gets the amountFieldName attribute.

Returns:

Returns the amountFieldName.

setAmountFieldName

public void setAmountFieldName(String amountFieldName)

Sets the amountFieldName attribute value.

Parameters:

amountFieldName - The amountFieldName to set.