org.kuali.kfs.sys.document.service
Interface AccountingLineRenderingService

All Known Implementing Classes:

AccountingLineRenderingServiceImpl

public interface AccountingLineRenderingService

Service that helps render accounting lines

Method Summary

AccountingLineViewFieldDefinition	createGenericAccountingLineViewFieldDefinition(org.kuali.rice.kns.datadictionary.MaintainableFieldDefinition fieldDefinition) Begins to create an AccountingLineViewFieldDefinition, based on the information held within the given MaintainableFieldDefinition
KualiAccountingDocumentFormBase	findForm(javax.servlet.jsp.PageContext pageContext) Looks in likely places to find the form that is used by the page context for rendering an accounting document
FieldRenderer	getFieldRendererForField(org.kuali.rice.kns.web.ui.Field field, AccountingLine accountingLineToRender) Based on the control type of the field, returns a proper field renderer
void	performPostTablificationTransformations(List<AccountingLineTableRow> rows, AccountingLineGroupDefinition groupDefinition, AccountingDocument document, AccountingLine accountingLine, boolean newLine) Performs any transformations that should happen after tablification
void	performPreTablificationTransformations(List<TableJoining> elements, AccountingLineGroupDefinition groupDefinition, AccountingDocument document, AccountingLine accountingLine, boolean newLine, Map unconvertedValues, String accountingLinePropertyName) Performs any known transformations against the List of AccountingLineViewRenderableElements
List<AccountingLineTableRow>	tablify(List<TableJoining> elements) Given a list of renderable elements, determines how to split that into rows, cells, and fields

Method Detail

tablify

List<AccountingLineTableRow> tablify(List<TableJoining> elements)

Given a list of renderable elements, determines how to split that into rows, cells, and fields

Parameters:

elements - renderable elements to find table form for

Returns:

a list of table rows that can be rendered

performPreTablificationTransformations

void performPreTablificationTransformations(List<TableJoining> elements,
                                            AccountingLineGroupDefinition groupDefinition,
                                            AccountingDocument document,
                                            AccountingLine accountingLine,
                                            boolean newLine,
                                            Map unconvertedValues,
                                            String accountingLinePropertyName)

Performs any known transformations against the List of AccountingLineViewRenderableElements

Parameters:

elements - the List of elements to transform

definition - the accounting line group definition that gives instructions to the particular rendering we're attempting

document - the Accounting Document we're rendering lines from

accountingLine - the line we're rendering

newLine - true if what is being rendered is the new line in the form; false otherwise

unconvertedValues - any unconverted values stored in the form

accountingLinePropertyName - the property path to this accounting line

performPostTablificationTransformations

void performPostTablificationTransformations(List<AccountingLineTableRow> rows,
                                             AccountingLineGroupDefinition groupDefinition,
                                             AccountingDocument document,
                                             AccountingLine accountingLine,
                                             boolean newLine)

Performs any transformations that should happen after tablification

Parameters:

rows - the tablified rows

groupDefinition - the data dictionary definition of the group to render

document - the Accounting Document we're rendering lines from

accountingLine - the line we're rendering the line which is being rendered

newLine - true if what is being rendered is the new line in the form; false otherwise

findForm

KualiAccountingDocumentFormBase findForm(javax.servlet.jsp.PageContext pageContext)

Looks in likely places to find the form that is used by the page context for rendering an accounting document

Parameters:

pageContext - the pageContext to find the form in

Returns:

the form for the page being rendered

getFieldRendererForField

FieldRenderer getFieldRendererForField(org.kuali.rice.kns.web.ui.Field field,
                                       AccountingLine accountingLineToRender)

Based on the control type of the field, returns a proper field renderer

Returns:

the field renderer which will properly display this field

createGenericAccountingLineViewFieldDefinition

AccountingLineViewFieldDefinition createGenericAccountingLineViewFieldDefinition(org.kuali.rice.kns.datadictionary.MaintainableFieldDefinition fieldDefinition)

Begins to create an AccountingLineViewFieldDefinition, based on the information held within the given MaintainableFieldDefinition

Parameters:

fieldDefinition - the field definition to create a generic accounting line view field version of

Returns:

a basic AccountingLineViewFieldDefinition