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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

SecAccountingLineGroupDefinition

public class AccountingLineGroupDefinition
extends org.kuali.rice.kns.datadictionary.DataDictionaryDefinitionBase

Data dictionary definition that includes metadata for an accounting document about one of its groups of accounting lines (typically source vs. target, but this should open things up).

See Also:

Serialized Form

Field Summary

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

id

Constructor Summary

AccountingLineGroupDefinition()

Method Summary

void	completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass) Validates that: 1) this accounting line group has an accounting line class 2) this accounting line group has an accounting line view
protected AccountingLineAuthorizer	createAccountingLineAuthorizer() Creates an instance of the accounting line authorizer
DefaultAccountingLineGroupImpl	createAccountingLineGroup(AccountingDocument accountingDocument, List<RenderableAccountingLineContainer> containers, String collectionPropertyName, String collectionItemPropertyName, Map<String,Object> displayedErrors, Map<String,Object> displayedWarnings, Map<String,Object> displayedInfo, boolean canEdit) Creates a new accounting line group for this definition
AccountingLineAuthorizer	getAccountingLineAuthorizer() Returns an instance of the accounting line authorizer for this group
Class<? extends AccountingLineAuthorizer>	getAccountingLineAuthorizerClass() Gets the accountingLineAuthorizerClass attribute.
Class<? extends AccountingLine>	getAccountingLineClass() Gets the accountingLineClass attribute.
Comparator<AccountingLine>	getAccountingLineComparator()
List<? extends AccountingLineViewActionDefinition>	getAccountingLineGroupActions() Gets the accountingLineGroupActions attribute.
Class<? extends DefaultAccountingLineGroupImpl>	getAccountingLineGroupClass() Gets the accountingLineGroupClass attribute.
AccountingLineViewDefinition	getAccountingLineView() Gets the accountingLineView attribute.
String	getErrorKey() Gets the errorKey attribute.
int	getForceColumnCount() Gets the forceColumnCount attribute.
String	getGroupLabel() Gets the groupLabel attribute.
String	getImportedLinePropertyPrefix() Gets the importedLinePropertyPrefix attribute.
List<? extends TotalDefinition>	getTotals() Gets the totals attribute.
boolean	isHeaderRendering() Gets the headerRendering attribute.
boolean	isImportingAllowed() Gets the importingAllowed attribute.
boolean	isTopHeadersAfterFirstLineHiding() Gets the topHeadersAfterFirstLineHiding attribute.
void	setAccountingLineAuthorizerClass(Class<? extends AccountingLineAuthorizer> accountingLineAuthorizerClass) Sets the accountingLineAuthorizerClass attribute value.
void	setAccountingLineClass(Class<? extends AccountingLine> accountingLineClass) Sets the accountingLineClass attribute value.
void	setAccountingLineComparatorClass(Class<? extends Comparator<AccountingLine>> accountingLineComparatorClass) Sets the accountingLineComparatorClass attribute value.
void	setAccountingLineGroupActions(List<? extends AccountingLineViewActionDefinition> accountingLineGroupActions) Sets the accountingLineGroupActions attribute value.
void	setAccountingLineGroupClass(Class<? extends DefaultAccountingLineGroupImpl> accountingLineGroupClass) Sets the accountingLineGroupClass attribute value.
void	setAccountingLineView(AccountingLineViewDefinition accountingLineView) Sets the accountingLineView attribute value.
void	setErrorKey(String errorKey) Sets the errorKey attribute value.
void	setForceColumnCount(int forceColumnCount) Sets the forceColumnCount attribute value.
void	setGroupLabel(String groupLabel) Sets the groupLabel attribute value.
void	setHeaderRendering(boolean headerRendering) Sets the headerRendering attribute value.
void	setImportedLinePropertyPrefix(String importedLinePropertyPrefix) Sets the importedLinePropertyPrefix attribute value.
void	setImportingAllowed(boolean importingAllowed) Sets the importingAllowed attribute value.
void	setTopHeadersAfterFirstLineHiding(boolean showTopHeadersAfterFirstLine) Sets the topHeadersAfterFirstLineHiding attribute value.
void	setTotals(List<? extends TotalDefinition> totals) Sets the totals attribute value.

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

AccountingLineGroupDefinition

public AccountingLineGroupDefinition()

Method Detail

completeValidation

public void completeValidation(Class rootBusinessObjectClass,
                               Class otherBusinessObjectClass)

Validates that: 1) this accounting line group has an accounting line class 2) this accounting line group has an accounting line view

See Also:

DataDictionaryDefinition.completeValidation(java.lang.Class, java.lang.Class)

getAccountingLineClass

public Class<? extends AccountingLine> getAccountingLineClass()

Gets the accountingLineClass attribute.

Returns:

Returns the accountingLineClass.

setAccountingLineClass

public void setAccountingLineClass(Class<? extends AccountingLine> accountingLineClass)

Sets the accountingLineClass attribute value.

Parameters:

accountingLineClass - The accountingLineClass to set.

getAccountingLineView

public AccountingLineViewDefinition getAccountingLineView()

Gets the accountingLineView attribute.

Returns:

Returns the accountingLineView.

setAccountingLineView

public void setAccountingLineView(AccountingLineViewDefinition accountingLineView)

Sets the accountingLineView attribute value.

Parameters:

accountingLineView - The accountingLineView to set.

getGroupLabel

public String getGroupLabel()

Gets the groupLabel attribute.

Returns:

Returns the groupLabel.

setGroupLabel

public void setGroupLabel(String groupLabel)

Sets the groupLabel attribute value.

Parameters:

groupLabel - The groupLabel to set.

getTotals

public List<? extends TotalDefinition> getTotals()

Gets the totals attribute.

Returns:

Returns the totals.

setTotals

public void setTotals(List<? extends TotalDefinition> totals)

Sets the totals attribute value.

Parameters:

totals - The totals to set.

getAccountingLineAuthorizerClass

public Class<? extends AccountingLineAuthorizer> getAccountingLineAuthorizerClass()

Gets the accountingLineAuthorizerClass attribute.

Returns:

Returns the accountingLineAuthorizerClass.

setAccountingLineAuthorizerClass

public void setAccountingLineAuthorizerClass(Class<? extends AccountingLineAuthorizer> accountingLineAuthorizerClass)

Sets the accountingLineAuthorizerClass attribute value.

Parameters:

accountingLineAuthorizerClass - The accountingLineAuthorizerClass to set.

getImportedLinePropertyPrefix

public String getImportedLinePropertyPrefix()

Gets the importedLinePropertyPrefix attribute.

Returns:

Returns the importedLinePropertyPrefix.

setImportedLinePropertyPrefix

public void setImportedLinePropertyPrefix(String importedLinePropertyPrefix)

Sets the importedLinePropertyPrefix attribute value.

Parameters:

importedLinePropertyPrefix - The importedLinePropertyPrefix to set.

getForceColumnCount

public int getForceColumnCount()

Gets the forceColumnCount attribute.

Returns:

Returns the forceColumnCount.

setForceColumnCount

public void setForceColumnCount(int forceColumnCount)

Sets the forceColumnCount attribute value.

Parameters:

forceColumnCount - The forceColumnCount to set.

getErrorKey

public String getErrorKey()

Gets the errorKey attribute.

Returns:

Returns the errorKey.

setErrorKey

public void setErrorKey(String errorKey)

Sets the errorKey attribute value.

Parameters:

errorKey - The errorKey to set.

getAccountingLineAuthorizer

public AccountingLineAuthorizer getAccountingLineAuthorizer()

Returns an instance of the accounting line authorizer for this group

Returns:

an instance of the accounting line authorizer

createAccountingLineAuthorizer

protected AccountingLineAuthorizer createAccountingLineAuthorizer()

Creates an instance of the accounting line authorizer

Returns:

the accounting line authorizer for this group

isTopHeadersAfterFirstLineHiding

public boolean isTopHeadersAfterFirstLineHiding()

Gets the topHeadersAfterFirstLineHiding attribute.

Returns:

Returns the topHeadersAfterFirstLineHiding.

setTopHeadersAfterFirstLineHiding

public void setTopHeadersAfterFirstLineHiding(boolean showTopHeadersAfterFirstLine)

Sets the topHeadersAfterFirstLineHiding attribute value.

Parameters:

topHeadersAfterFirstLineHiding - The topHeadersAfterFirstLineHiding to set.

isHeaderRendering

public boolean isHeaderRendering()

Gets the headerRendering attribute.

Returns:

Returns the headerRendering.

setHeaderRendering

public void setHeaderRendering(boolean headerRendering)

Sets the headerRendering attribute value.

Parameters:

headerRendering - The headerRendering to set.

getAccountingLineGroupActions

public List<? extends AccountingLineViewActionDefinition> getAccountingLineGroupActions()

Gets the accountingLineGroupActions attribute.

Returns:

Returns the accountingLineGroupActions.

setAccountingLineGroupActions

public void setAccountingLineGroupActions(List<? extends AccountingLineViewActionDefinition> accountingLineGroupActions)

Sets the accountingLineGroupActions attribute value.

Parameters:

accountingLineGroupActions - The accountingLineGroupActions to set.

isImportingAllowed

public boolean isImportingAllowed()

Gets the importingAllowed attribute.

Returns:

Returns the importingAllowed.

setImportingAllowed

public void setImportingAllowed(boolean importingAllowed)

Sets the importingAllowed attribute value.

Parameters:

importingAllowed - The importingAllowed to set.

getAccountingLineGroupClass

public Class<? extends DefaultAccountingLineGroupImpl> getAccountingLineGroupClass()

Gets the accountingLineGroupClass attribute.

Returns:

Returns the accountingLineGroupClass.

setAccountingLineGroupClass

public void setAccountingLineGroupClass(Class<? extends DefaultAccountingLineGroupImpl> accountingLineGroupClass)

Sets the accountingLineGroupClass attribute value.

Parameters:

accountingLineGroupClass - The accountingLineGroupClass to set.

setAccountingLineComparatorClass

public void setAccountingLineComparatorClass(Class<? extends Comparator<AccountingLine>> accountingLineComparatorClass)

Sets the accountingLineComparatorClass attribute value.

Parameters:

accountingLineComparatorClass - The accountingLineComparatorClass to set.

getAccountingLineComparator

public Comparator<AccountingLine> getAccountingLineComparator()

Returns:

an instance of the Comparator this group should use to sort accounting lines

createAccountingLineGroup

public DefaultAccountingLineGroupImpl createAccountingLineGroup(AccountingDocument accountingDocument,
                                                                List<RenderableAccountingLineContainer> containers,
                                                                String collectionPropertyName,
                                                                String collectionItemPropertyName,
                                                                Map<String,Object> displayedErrors,
                                                                Map<String,Object> displayedWarnings,
                                                                Map<String,Object> displayedInfo,
                                                                boolean canEdit)

Creates a new accounting line group for this definition

Parameters:

accountingDocument - the document which owns or will own the accounting line being rendered

containers - the containers within this group

collectionPropertyName - the property name of the collection of accounting lines owned by this group

errors - a List of errors keys for errors on the page

displayedErrors - a Map of errors that have already been displayed

canEdit - determines if the page can be edited or not

Returns:

a newly created and initialized accounting line group