org.kuali.ole.fp.controller

Class OLECapitalAccountingLinesControllerBase

java.lang.Object

org.kuali.rice.krad.web.controller.UifControllerBase

org.kuali.rice.krad.document.DocumentControllerBase

org.kuali.rice.krad.document.TransactionalDocumentControllerBase

org.kuali.ole.olekrad.controller.OLEKRADTransactionController

org.kuali.ole.sys.document.web.controller.OLEFinancialSystemTransactionalDocumentControllerBase

org.kuali.ole.sys.web.controller.OLEKualiAccountingDocumentControllerBase

org.kuali.ole.fp.document.controller.OLECapitalAssetInformationControllerBase

org.kuali.ole.fp.controller.OLECapitalAccountingLinesControllerBase

Direct Known Subclasses:

DistributionOfIncomeAndExpenseController

public abstract class OLECapitalAccountingLinesControllerBase
extends OLECapitalAssetInformationControllerBase

This is the action class for the CapitalAccountingLinesActionBase.

Field Summary

Fields inherited from class org.kuali.ole.fp.document.controller.OLECapitalAssetInformationControllerBase

LOG

Fields inherited from class org.kuali.ole.sys.web.controller.OLEKualiAccountingDocumentControllerBase

UPDATE_EVENT_ACTIONS

Fields inherited from class org.kuali.ole.sys.document.web.controller.OLEFinancialSystemTransactionalDocumentControllerBase

MODULE_LOCKED_MESSAGE, MODULE_LOCKED_URL_SUFFIX

Constructor Summary

Constructors

Constructor and Description
OLECapitalAccountingLinesControllerBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	capitalAccountingLinesSelected(OLECapitalAccountingLinesFormBase calfb) checks the capital accounting lines if any of the lines have been selected for further processing.
protected boolean	checkDistributedAccountingLineExists(List<CapitalAccountingLines> capitalAccountingLines, CapitalAssetAccountsGroupDetails groupAccountLine) checks capital accounting lines again the distributed accounting line and if found return true else false so that this distributed accounting line may be removed.
protected boolean	checkObjecSubTypeCrossingCapitalAccountingLines(org.kuali.rice.krad.document.Document document) runs the validation to check if object subtypes crosses groups on selected capital accounting lines.
org.springframework.web.servlet.ModelAndView	correct(org.kuali.rice.krad.web.form.DocumentFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) removes capitalaccountinglines which is a transient bo..
org.springframework.web.servlet.ModelAndView	createAsset(org.kuali.rice.krad.web.form.DocumentFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Action "create" creates assets for the selected capital accounting lines.
protected void	createCapitalAssetsForSelectedAccountingLines(org.kuali.rice.krad.web.form.DocumentFormBase form, OLECapitalAccountingLinesFormBase calfb, String actionTypeIndicator, String distributionAmountCode) Helper method to first calculate the percents for the selected capital accounting lines as the percent is required if the user is distributing the amounts by individual amount method.
protected void	deleteAccountingLine(boolean isSource, OLEKualiAccountingDocumentFormBase oleFinancialDocumentForm, int deleteIndex) When user deletes an accounting line to the either source or target, the corresponding line in capital accounting line is deleted and the distributed accounting line under the created or modified capital asset line.
protected List<CapitalAccountingLines>	deleteCapitalAccountingLine(List<CapitalAccountingLines> capitalAccountingLines, AccountingLine line) If the line exists in capital accounting lines, that will be deleted.
protected OLECapitalAccountingLinesControllerBaseServiceImpl	getControllerService()
protected org.kuali.rice.krad.service.KualiRuleService	getRuleService() Get the rule service
protected void	insertAccountingLine(boolean isSource, OLEKualiAccountingDocumentFormBase oleFinancialDocumentForm, AccountingLine line) When user adds an accounting line to the either source or target, if the object code on that line has capital object type code group then a capital accounting line is created.
org.springframework.web.servlet.ModelAndView	modifyAsset(org.kuali.rice.krad.web.form.DocumentFormBase form, org.springframework.validation.BindingResult result, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Action "modify" creates assets for the selected capital accounting lines.
org.springframework.web.servlet.ModelAndView	refresh(org.kuali.rice.krad.web.form.DocumentFormBase form) Multi-value asset lookup is implemented through the integration package by module's service to gather the results.
protected boolean	removeOrphanCapitalAccountingLine(List<AccountingLine> accountLines, CapitalAccountingLines capitalAccountingLine) If the line exists in capital accounting lines, and that line does not exist in accounting lines (source or target) then remove the line from capital accounting lines.
protected List<CapitalAccountingLines>	removeOrphanCapitalAccountingLines(List<CapitalAccountingLines> capitalAccountingLines, OLEAccountingDocument tdoc) updates the capital accounting lines looking at source and/or target accounting lines.
protected void	removeOrphanDisributedAccountingLine(List<CapitalAccountingLines> capitalAccountingLines, CapitalAssetInformation capitalAsset) Method to check for any distributed accounting line for a given capital accounting line that are not listed in the capital assets accounting lines and remove it.
protected void	removeOrphanDisributedAccountingLines(List<CapitalAccountingLines> capitalAccountingLines, List<CapitalAssetInformation> capitalAssets) Method to check for any distributed accounting lines that are not listed in the capital accounting lines and remove them.
void	setControllerService(org.kuali.rice.krad.web.service.ControllerService controllerService)
protected void	sortCaptitalAccountingLines(List<CapitalAccountingLines> capitalAccountingLines) sort the capital accounting lines collection based on financial object code and account number.
protected void	updateCapitalAccountingLine(List<CapitalAccountingLines> capitalAccountingLines, AccountingLine line) Checks if the accounting line exits in the capital accounting lines and if so, updates the other information.
protected List<CapitalAccountingLines>	updateCapitalAccountingLines(List<CapitalAccountingLines> capitalAccountingLines, OLEAccountingDocument tdoc) updates the capital accounting lines looking at source and/or target accounting lines.
protected void	uploadAccountingLines(boolean isSource, org.kuali.rice.krad.web.form.DocumentFormBase form) After uploading the accounting lines, the capital accounting lines will be created from these.

Methods inherited from class org.kuali.ole.fp.document.controller.OLECapitalAssetInformationControllerBase

accountingLinesAmountDistributed, addCapitalAssetInfoDetailLines, addCapitalAssetTagLocationInfo, addMissingAccountingLinesToCapitalAsset, adjustAccountingLineAmountOnLastCapitalAsset, adjustAccountingLinesAmounts, adjustCapitalAssetsAccountingLinesAmounts, adjustVarianceOnCapitalAssets, calculateRemainingDistributedAmount, capitalAccountingLineMissing, capitalAssetAmountAlreadyDistributedToGroupAccountingLines, capitalAssetCreated, capitalAssetExists, checkSelectForCapitalAccountingLines, clearCapitalAssetInfo, clearCapitalAssetModify, copy, createCapitalAssetAccountingLinesDetails, createCapitalAssetForGroupAccountingLines, createCapitalAssetInformationDetail, createNewCapitalAsset, createNewModifyCapitalAsset, deleteCapitalAssetInfo, deleteCapitalAssetInfoDetailLine, deleteCapitalAssetLines, deleteCapitalAssetModify, DistributeCapitalAssetAmountToGroupAccountingLines, getAccountingLinesDistributedAmount, getAccountingLinesTotalAmount, getCapitalAccountingLinePercent, getCapitalAssetAccountLineAmount, getCapitalAssetsAmountAllocated, getNextAccountingLineNumber, getNextCapitalAssetLineNumber, getNextLineItemNumber, getNumberOfModifiedAssetsExist, getRemainingAmounToDistribute, getTotalCapitalAccountsAmounts, getTotalQuantityOfCreateAssets, insertCapitalAssetInfo, modifyAssetAlreadyExists, modifyCapitalAssetCreated, numberOfCreateAssetsExist, processRemainingCapitalAssetInfo, redistributeAmountsForAccountingsLineForModifyAssets, redistributeAmountsForAccountingsLineForModifyAssetsByAmounts, redistributeCostEquallyForModifiedAssets, redistributeCreateCapitalAssetAmount, redistributeEqualAmounts, redistributeEqualAmountsForAccountingLineForCreateAssets, redistributeEqualAmountsOnLastCapitalAsset, redistributeIndividualAmounts, redistributeIndividualAmountsForAccountingLinesForCreateAssets, redistributeIndividualAmountsForAccountingLinesForModifyAssets, redistributeModifyCapitalAssetAmount, redistributeToGroupAccountingLinesFromAssetsByAmounts, refreshCapitalAssetModify, removeDistributedAccountingLine, removeEmptyCapitalAssetModify, resetCapitalAssetInfo, uncheckCapitalAccountingLinesSelected

Methods inherited from class org.kuali.ole.sys.web.controller.OLEKualiAccountingDocumentControllerBase

approve, blanketApprove, checkSalesTax, checkSalesTaxRequiredAllLines, checkUploadFile, deepCopyAccountingLinesList, deleteSourceLine, deleteTargetLine, docHandler, getObjectTypeCodeFromLine, getSourceAccountingLine, getTargetAccountingLine, handleSalesTaxRequired, handleSalesTaxRequiredAllLines, hasSalesTaxBeenEntered, hideDetails, insertSourceLine, insertTargetLine, isSalesTaxRequired, isValidSalesTaxEntered, performBalanceInquiryForAccountingLine, performBalanceInquiryForSourceLine, performBalanceInquiryForTargetLine, populateSalesTax, processAccountingLines, refreshSalesTaxInfo, removeSalesTax, route, save, showDetails, toggleTab, uploadSourceLines, uploadTargetLines

Methods inherited from class org.kuali.ole.sys.document.web.controller.OLEFinancialSystemTransactionalDocumentControllerBase

isDocumentLocked

Methods inherited from class org.kuali.ole.olekrad.controller.OLEKRADTransactionController

createInitialForm, getDocumentService, getLineToDelete, getLineToEdit, getNoteService, getSelectedLine

Methods inherited from class org.kuali.rice.krad.document.TransactionalDocumentControllerBase

copy

Methods inherited from class org.kuali.rice.krad.document.DocumentControllerBase

acknowledge, cancelAttachment, close, complete, deleteNote, disapprove, downloadAttachment, fyi, insertNote, recall, reload, save, sendAdHocRequests, superUserApprove, superUserDisapprove, superUserTakeActions, supervisorFunctions

Methods inherited from class org.kuali.rice.krad.web.controller.UifControllerBase

addBlankLine, addFileUploadLine, addLine, back, cancel, checkForm, closeEditLineDialog, defaultMapping, deleteFileUploadLine, deleteLine, editLine, getCollectionControllerService, getFileControllerService, getFileFromLine, getMessageView, getModelAndView, getModelAndView, getModelAndView, getModelAndViewService, getModelAndViewWithInit, getModelAndViewWithInit, getNavigationControllerService, getQueryControllerService, getRefreshControllerService, getSaveControllerService, initForm, navigate, performFieldQuery, performFieldSuggest, performLookup, performRedirect, performRedirect, refresh, retrieveCollectionPage, retrieveEditLineDialog, returnToHub, returnToPrevious, saveField, saveLine, sessionTimeout, setCollectionControllerService, setFileControllerService, setModelAndViewService, setNavigationControllerService, setQueryControllerService, setRefreshControllerService, setSaveControllerService, showDialog, start, tableJsonRetrieval

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OLECapitalAccountingLinesControllerBase

public OLECapitalAccountingLinesControllerBase()

Method Detail

correct

@RequestMapping(params="methodToCall=correct")
public org.springframework.web.servlet.ModelAndView correct(@ModelAttribute(value="KualiForm")
                                                                  org.kuali.rice.krad.web.form.DocumentFormBase form,
                                                                  org.springframework.validation.BindingResult result,
                                                                  javax.servlet.http.HttpServletRequest request,
                                                                  javax.servlet.http.HttpServletResponse response)
                                                     throws Exception

removes capitalaccountinglines which is a transient bo.. and call the super method to create a error correction document.

Overrides:

correct in class OLEFinancialSystemTransactionalDocumentControllerBase

Returns:

ActionForward

Throws:

Exception - KRAD Conversion: Customizing the extra buttons on the form

See Also:

FinancialSystemTransactionalDocumentActionBase.correct(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

refresh

public org.springframework.web.servlet.ModelAndView refresh(@ModelAttribute(value="KualiForm")
                                                   org.kuali.rice.krad.web.form.DocumentFormBase form)
                                                     throws Exception

Description copied from class: OLECapitalAssetInformationControllerBase

Multi-value asset lookup is implemented through the integration package by module's service to gather the results. The results are processed for any capital accounting lines where the line is marked for selection. After the capital assets are populated with the selected asset numbers, the system control amount is redistributed equally among the assets when the distribution method is "distribute cost equally".

Overrides:

refresh in class OLECapitalAssetInformationControllerBase

Throws:

Exception

See Also:

KualiAction.refresh(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

insertAccountingLine

protected void insertAccountingLine(boolean isSource,
                        OLEKualiAccountingDocumentFormBase oleFinancialDocumentForm,
                        AccountingLine line)

When user adds an accounting line to the either source or target, if the object code on that line has capital object type code group then a capital accounting line is created.

Overrides:

insertAccountingLine in class OLEKualiAccountingDocumentControllerBase

See Also:

KualiAccountingDocumentActionBase.insertAccountingLine(boolean, org.kuali.ole.sys.web.struts.KualiAccountingDocumentFormBase, org.kuali.ole.sys.businessobject.AccountingLine)

deleteAccountingLine

protected void deleteAccountingLine(boolean isSource,
                        OLEKualiAccountingDocumentFormBase oleFinancialDocumentForm,
                        int deleteIndex)

When user deletes an accounting line to the either source or target, the corresponding line in capital accounting line is deleted and the distributed accounting line under the created or modified capital asset line. When a capital asset does not have any accounting lines, the capital asset is removed.

Overrides:

deleteAccountingLine in class OLEKualiAccountingDocumentControllerBase

See Also:

KualiAccountingDocumentActionBase.deleteAccountingLine(boolean, org.kuali.ole.sys.web.struts.KualiAccountingDocumentFormBase, int)

uploadAccountingLines

protected void uploadAccountingLines(boolean isSource,
                         org.kuali.rice.krad.web.form.DocumentFormBase form)
                              throws FileNotFoundException,
                                     IOException

After uploading the accounting lines, the capital accounting lines will be created from these.

Overrides:

uploadAccountingLines in class OLEKualiAccountingDocumentControllerBase

Throws:

FileNotFoundException

IOException

See Also:

KualiAccountingDocumentActionBase.uploadAccountingLines(boolean, org.apache.struts.action.ActionForm)

updateCapitalAccountingLines

protected List<CapitalAccountingLines> updateCapitalAccountingLines(List<CapitalAccountingLines> capitalAccountingLines,
                                                        OLEAccountingDocument tdoc)

updates the capital accounting lines looking at source and/or target accounting lines.

Parameters:

capitalAccountingLines -

tdoc -

removeOrphanCapitalAccountingLines

protected List<CapitalAccountingLines> removeOrphanCapitalAccountingLines(List<CapitalAccountingLines> capitalAccountingLines,
                                                              OLEAccountingDocument tdoc)

updates the capital accounting lines looking at source and/or target accounting lines. Removes any capital accounting line that does not have a corresponding source or target accounting line.

Parameters:

capitalAccountingLines -

tdoc -

removeOrphanCapitalAccountingLine

protected boolean removeOrphanCapitalAccountingLine(List<AccountingLine> accountLines,
                                        CapitalAccountingLines capitalAccountingLine)

If the line exists in capital accounting lines, and that line does not exist in accounting lines (source or target) then remove the line from capital accounting lines.

Parameters:

capitalAccountingLines -

line - to remove

Returns:

true if the capital accounting line to be removed is found in accounting lines, else false

removeOrphanDisributedAccountingLines

protected void removeOrphanDisributedAccountingLines(List<CapitalAccountingLines> capitalAccountingLines,
                                         List<CapitalAssetInformation> capitalAssets)

Method to check for any distributed accounting lines that are not listed in the capital accounting lines and remove them.

Parameters:

capitalAccountingLines -

capitalAssets -

removeOrphanDisributedAccountingLine

protected void removeOrphanDisributedAccountingLine(List<CapitalAccountingLines> capitalAccountingLines,
                                        CapitalAssetInformation capitalAsset)

Method to check for any distributed accounting line for a given capital accounting line that are not listed in the capital assets accounting lines and remove it.

Parameters:

capitalAccountingLines -

capitalAsset -

checkDistributedAccountingLineExists

protected boolean checkDistributedAccountingLineExists(List<CapitalAccountingLines> capitalAccountingLines,
                                           CapitalAssetAccountsGroupDetails groupAccountLine)

checks capital accounting lines again the distributed accounting line and if found return true else false so that this distributed accounting line may be removed.

Parameters:

capitalAccountingLines -

groupAccountLine -

Returns:

true if accounting line exists else return false

updateCapitalAccountingLine

protected void updateCapitalAccountingLine(List<CapitalAccountingLines> capitalAccountingLines,
                               AccountingLine line)

Checks if the accounting line exits in the capital accounting lines and if so, updates the other information. else inserts a new record into the collection

Parameters:

capitalAccountingLines -

line -

deleteCapitalAccountingLine

protected List<CapitalAccountingLines> deleteCapitalAccountingLine(List<CapitalAccountingLines> capitalAccountingLines,
                                                       AccountingLine line)

If the line exists in capital accounting lines, that will be deleted.

Parameters:

capitalAccountingLines -

line - to remove

Returns:

List of capitalAccountingLines

sortCaptitalAccountingLines

protected void sortCaptitalAccountingLines(List<CapitalAccountingLines> capitalAccountingLines)

sort the capital accounting lines collection based on financial object code and account number.

Parameters:

capitalAccountingLines - List of capital accounting lines

createAsset

@RequestMapping(params="methodToCall=createAsset")
public org.springframework.web.servlet.ModelAndView createAsset(@ModelAttribute(value="KualiForm")
                                                                      org.kuali.rice.krad.web.form.DocumentFormBase form,
                                                                      org.springframework.validation.BindingResult result,
                                                                      javax.servlet.http.HttpServletRequest request,
                                                                      javax.servlet.http.HttpServletResponse response)
                                                         throws Exception

Action "create" creates assets for the selected capital accounting lines. An error message is shown if no capital accounting lines are selected for processing. The action checks if the selected capital accounting lines object sub type cross based on the system paramter values for the object subtypes and if so prompts the user to confirm to continue to create the assets for the select capital accounting lines.

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

modifyAsset

@RequestMapping(params="methodToCall=modifyAsset")
public org.springframework.web.servlet.ModelAndView modifyAsset(@ModelAttribute(value="KualiForm")
                                                                      org.kuali.rice.krad.web.form.DocumentFormBase form,
                                                                      org.springframework.validation.BindingResult result,
                                                                      javax.servlet.http.HttpServletRequest request,
                                                                      javax.servlet.http.HttpServletResponse response)
                                                         throws Exception

Action "modify" creates assets for the selected capital accounting lines. An error message is shown if no capital accounting lines are selected for processing. The action checks if the selected capital accounting lines object sub type cross based on the system paramter values for the object subtypes and if so prompts the user to confirm to continue to create the assets for the select capital accounting lines.

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

createCapitalAssetsForSelectedAccountingLines

protected void createCapitalAssetsForSelectedAccountingLines(org.kuali.rice.krad.web.form.DocumentFormBase form,
                                                 OLECapitalAccountingLinesFormBase calfb,
                                                 String actionTypeIndicator,
                                                 String distributionAmountCode)

Helper method to first calculate the percents for the selected capital accounting lines as the percent is required if the user is distributing the amounts by individual amount method. It then populates created or modified assets with asset accounting lines.

Parameters:

form -

calfb -

actionTypeIndicator - indicates whether creating an asset for "create" or "modify" actions.

distributionAmountCode - amount distribution code

capitalAccountingLinesSelected

protected boolean capitalAccountingLinesSelected(OLECapitalAccountingLinesFormBase calfb)

checks the capital accounting lines if any of the lines have been selected for further processing.

Parameters:

calfb -

Returns:

selected return true if lines have been selected else return false

checkObjecSubTypeCrossingCapitalAccountingLines

protected boolean checkObjecSubTypeCrossingCapitalAccountingLines(org.kuali.rice.krad.document.Document document)

runs the validation to check if object subtypes crosses groups on selected capital accounting lines.

Parameters:

form -

Returns:

true if rule passed else false

getRuleService

protected org.kuali.rice.krad.service.KualiRuleService getRuleService()

Get the rule service

Returns:

ruleService

getControllerService

protected OLECapitalAccountingLinesControllerBaseServiceImpl getControllerService()

Overrides:

getControllerService in class OLECapitalAssetInformationControllerBase

setControllerService

@Autowired
@Qualifier(value="oleCapitalAccountingLinesControllerBaseService")
public void setControllerService(org.kuali.rice.krad.web.service.ControllerService controllerService)

Overrides:

setControllerService in class OLECapitalAssetInformationControllerBase