org.kuali.kfs.fp.document.web.struts

Class CapitalAccountingLinesActionBase

java.lang.Object

org.apache.struts.action.Action

org.apache.struts.actions.BaseAction

org.apache.struts.actions.DispatchAction

org.kuali.rice.kns.web.struts.action.KualiAction

org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase

org.kuali.rice.kns.web.struts.action.KualiTransactionalDocumentActionBase

org.kuali.kfs.sys.document.web.struts.FinancialSystemTransactionalDocumentActionBase

org.kuali.kfs.sys.web.struts.KualiAccountingDocumentActionBase

org.kuali.kfs.fp.document.web.struts.CapitalAssetInformationActionBase

org.kuali.kfs.fp.document.web.struts.CapitalAccountingLinesActionBase

Direct Known Subclasses:

AdvanceDepositAction, CashReceiptAction, CreditCardReceiptAction, DistributionOfIncomeAndExpenseAction, GeneralErrorCorrectionAction, InternalBillingAction, IntraAccountAdjustmentAction, ProcurementCardAction

public abstract class CapitalAccountingLinesActionBase
extends CapitalAssetInformationActionBase

This is the action class for the CapitalAccountingLinesActionBase.

Field Summary

Fields inherited from class org.kuali.kfs.fp.document.web.struts.CapitalAssetInformationActionBase

LOG

Fields inherited from class org.kuali.kfs.sys.web.struts.KualiAccountingDocumentActionBase

UPDATE_EVENT_ACTIONS

Fields inherited from class org.kuali.kfs.sys.document.web.struts.FinancialSystemTransactionalDocumentActionBase

MODULE_LOCKED_MESSAGE, MODULE_LOCKED_URL_SUFFIX

Fields inherited from class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase

DOCUMENT_LOAD_COMMANDS

Fields inherited from class org.kuali.rice.kns.web.struts.action.KualiAction

FORM_ACTION, FORWARD_NEXT, FORWARD_TEXT_AREA_UPDATE, METHOD_TO_CALL, POST_TEXT_AREA_TO_PARENT, TEXT_AREA_FIELD_ANCHOR, TEXT_AREA_FIELD_LABEL, TEXT_AREA_FIELD_NAME, TEXT_AREA_MAX_LENGTH, TEXT_AREA_READ_ONLY

Fields inherited from class org.apache.struts.actions.DispatchAction

clazz, log, methods, types

Fields inherited from class org.apache.struts.actions.BaseAction

messages

Fields inherited from class org.apache.struts.action.Action

servlet

Constructor Summary

Constructors

Constructor and Description
CapitalAccountingLinesActionBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected CapitalAccountingLines	addCapitalAccountingLine(List<CapitalAccountingLines> capitalAccountingLines, AccountingLine line) convenience method to add a new capital accounting line to the collection of capital accounting lines.
protected boolean	capitalAccountingLinesSelected(CapitalAccountingLinesFormBase calfb) checks the capital accounting lines if any of the lines have been selected for further processing.
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.apache.struts.action.ActionForward	correct(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) removes capitalaccountinglines which is a transient bo..
org.apache.struts.action.ActionForward	createAsset(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Action "create" creates assets for the selected capital accounting lines.
protected List<CapitalAccountingLines>	createCapitalAccountingLine(List<CapitalAccountingLines> capitalAccountingLines, AccountingLine line, String distributionAmountCode) Checks if the accounting line has an object code that belongs to object sub type group codes and if so, creates a capital accounting line that will be displayed on the jsp.
protected void	createCapitalAccountingLines(List<CapitalAccountingLines> capitalAccountingLines, AccountingDocument tdoc, String distributionAmountCode) creates the capital accounting lines looking at source and/or target accounting lines.
protected void	createCapitalAssetsForSelectedAccountingLines(org.apache.struts.action.ActionForm form, CapitalAccountingLinesFormBase 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.
org.apache.struts.action.ActionForward	deleteAccountingLinesForCapitalization(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Supports the delete button for capital accounting lines on the UI
org.apache.struts.action.ActionForward	docHandler(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Upon entry we need to set the capitalAccountingLinesExist boolean and check the tab states
org.apache.struts.action.ActionForward	execute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Upon entry we need to set the capitalAccountingLinesExist boolean and check the tab states
org.apache.struts.action.ActionForward	generateAccountingLinesForCapitalization(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Supports the generate button on the UI.
protected org.kuali.rice.krad.service.KualiRuleService	getRuleService() Get the rule service
protected void	initializeCapitalAccountingLinesExist(AccountingDocument tdoc) checks if the document has any capital accounting lines associated with it and sets CapitalAccountingLinesDocumentBase.capitalAccountingLinesExist if necessary
protected void	insertAccountingLine(boolean isSource, KualiAccountingDocumentFormBase kualiDocumentFormBase, 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.
protected void	loadDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase kualiDocumentFormBase) All document-load operations get routed through here
org.apache.struts.action.ActionForward	modifyAsset(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Action "modify" creates assets for the selected capital accounting lines.
protected org.apache.struts.action.ActionForward	performQuestionPrompt(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String actionTypeCode, String distributionAmountCode)
protected void	sortCaptitalAccountingLines(List<CapitalAccountingLines> capitalAccountingLines) sort the capital accounting lines collection based on financial object code and account number.

Methods inherited from class org.kuali.kfs.fp.document.web.struts.CapitalAssetInformationActionBase

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

Methods inherited from class org.kuali.kfs.sys.web.struts.KualiAccountingDocumentActionBase

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

Methods inherited from class org.kuali.kfs.sys.document.web.struts.FinancialSystemTransactionalDocumentActionBase

isDocumentLocked

Methods inherited from class org.kuali.rice.kns.web.struts.action.KualiTransactionalDocumentActionBase

populateAuthorizationFields

Methods inherited from class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase

acknowledge, attemptLockRelease, buildAuthorizationException, cancel, cancelBOAttachment, canSave, checkAndWarnAboutSensitiveData, checkAuthorization, close, combineAdHocRecipients, complete, convertSetToMap, createDocument, delete, deleteAdHocRoutePerson, deleteAdHocRouteWorkgroup, deleteBONote, determineNoteWorkflowNotificationAction, disapprove, doProcessingAfterPost, downloadBOAttachment, exitingDocument, fyi, generatePessimisticLockMessage, getAttachmentService, getBusinessObjectAuthorizationService, getBusinessObjectMetaDataService, getBusinessObjectService, getDataDictionaryService, getDocumentHelperService, getDocumentService, getEntityManagerFactory, getGroupService, getKualiConfigurationService, getKualiRuleService, getNoteService, getParameterService, getPessimisticLockService, getQuestion, hasPendingAdhocForCompletion, hideAllTabs, insertAdHocRoutePerson, insertAdHocRouteWorkgroup, insertBONote, isFormRepresentingLockObject, performRouteReport, populateAdHocActionRequestCodes, promptBeforeValidation, promptBeforeValidation, recall, refreshAdHocRoutingWorkgroupLookups, releaseLocks, reload, returnToSender, selectedAttachmentIndex, sendAdHocRequests, sendNoteWorkflowNotification, setupDocumentExit, setupPessimisticLockMessages, showAllTabs, streamToResponse, superUserApprove, superUserDisapprove, supervisorFunctions, takeSuperUserActions

Methods inherited from class org.kuali.rice.kns.web.struts.action.KualiAction

addMethodToCallToUncheckedList, defaultDispatch, dispatchMethod, findMethodToCall, getApplicationBaseUrl, getEncryptionService, getHeaderTabDispatch, getHeaderTabNavigateTo, getImageContext, getKualiModuleService, getLineToDelete, getLineToEdit, getReturnLocation, getRoleQualification, getSelectedLine, getTabToToggle, headerTab, isModuleLocked, performInquiry, performQuestionWithInput, performQuestionWithInputAgainBecauseOfErrors, performQuestionWithoutInput, performWorkgroupLookup, postTextAreaToParent, retrieveLookupParameterValue, updateTextArea, validateLookupInquiryFullParameter

Methods inherited from class org.apache.struts.actions.DispatchAction

cancelled, getMethod, getMethodName, getParameter, unspecified

Methods inherited from class org.apache.struts.action.Action

addErrors, addMessages, execute, generateToken, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet

Methods inherited from class java.lang.Object

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

Constructor Detail

CapitalAccountingLinesActionBase

public CapitalAccountingLinesActionBase()

Method Detail

execute

public org.apache.struts.action.ActionForward execute(org.apache.struts.action.ActionMapping mapping,
                                             org.apache.struts.action.ActionForm form,
                                             javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
                                               throws Exception

Upon entry we need to set the capitalAccountingLinesExist boolean and check the tab states

Overrides:

execute in class KualiAccountingDocumentActionBase

Throws:

Exception

See Also:

KualiAccountingDocumentActionBase.execute(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

docHandler

public org.apache.struts.action.ActionForward docHandler(org.apache.struts.action.ActionMapping mapping,
                                                org.apache.struts.action.ActionForm form,
                                                javax.servlet.http.HttpServletRequest request,
                                                javax.servlet.http.HttpServletResponse response)
                                                  throws Exception

Upon entry we need to set the capitalAccountingLinesExist boolean and check the tab states

Overrides:

docHandler in class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase

Throws:

Exception

See Also:

KualiDocumentActionBase.docHandler(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

correct

public org.apache.struts.action.ActionForward correct(org.apache.struts.action.ActionMapping mapping,
                                             org.apache.struts.action.ActionForm form,
                                             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 FinancialSystemTransactionalDocumentActionBase

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)

loadDocument

protected void loadDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase kualiDocumentFormBase)
                     throws org.kuali.rice.kew.api.exception.WorkflowException

All document-load operations get routed through here

Overrides:

loadDocument in class KualiAccountingDocumentActionBase

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

KualiDocumentActionBase.loadDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase)

initializeCapitalAccountingLinesExist

protected void initializeCapitalAccountingLinesExist(AccountingDocument tdoc)

checks if the document has any capital accounting lines associated with it and sets CapitalAccountingLinesDocumentBase.capitalAccountingLinesExist if necessary

Parameters:

tdoc -

insertAccountingLine

protected void insertAccountingLine(boolean isSource,
                        KualiAccountingDocumentFormBase kualiDocumentFormBase,
                        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 KualiAccountingDocumentActionBase

See Also:

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

createCapitalAccountingLines

protected void createCapitalAccountingLines(List<CapitalAccountingLines> capitalAccountingLines,
                                AccountingDocument tdoc,
                                String distributionAmountCode)

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

Parameters:

capitalAccountingLines -

tdoc -

distributionAmountCode - distribution amount code for the line

createCapitalAccountingLine

protected List<CapitalAccountingLines> createCapitalAccountingLine(List<CapitalAccountingLines> capitalAccountingLines,
                                                       AccountingLine line,
                                                       String distributionAmountCode)

Checks if the accounting line has an object code that belongs to object sub type group codes and if so, creates a capital accounting line that will be displayed on the jsp.

Parameters:

capitalAccountingLines -

line -

distributionAmountCode -

Returns:

List of capitalAccountingLines

addCapitalAccountingLine

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

convenience method to add a new capital accounting line to the collection of capital accounting lines.

Parameters:

capitalAccountingLines -

line -

Returns:

cal newly created capital accounting line

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

generateAccountingLinesForCapitalization

public org.apache.struts.action.ActionForward generateAccountingLinesForCapitalization(org.apache.struts.action.ActionMapping mapping,
                                                                              org.apache.struts.action.ActionForm form,
                                                                              javax.servlet.http.HttpServletRequest request,
                                                                              javax.servlet.http.HttpServletResponse response)
                                                                                throws Exception

Supports the generate button on the UI. It generates the capital accounting lines

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

deleteAccountingLinesForCapitalization

public org.apache.struts.action.ActionForward deleteAccountingLinesForCapitalization(org.apache.struts.action.ActionMapping mapping,
                                                                            org.apache.struts.action.ActionForm form,
                                                                            javax.servlet.http.HttpServletRequest request,
                                                                            javax.servlet.http.HttpServletResponse response)
                                                                              throws Exception

Supports the delete button for capital accounting lines on the UI

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

createAsset

public org.apache.struts.action.ActionForward createAsset(org.apache.struts.action.ActionMapping mapping,
                                                 org.apache.struts.action.ActionForm form,
                                                 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

public org.apache.struts.action.ActionForward modifyAsset(org.apache.struts.action.ActionMapping mapping,
                                                 org.apache.struts.action.ActionForm form,
                                                 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.apache.struts.action.ActionForm form,
                                                 CapitalAccountingLinesFormBase 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(CapitalAccountingLinesFormBase 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

performQuestionPrompt

protected org.apache.struts.action.ActionForward performQuestionPrompt(org.apache.struts.action.ActionMapping mapping,
                                                           org.apache.struts.action.ActionForm form,
                                                           javax.servlet.http.HttpServletRequest request,
                                                           javax.servlet.http.HttpServletResponse response,
                                                           String actionTypeCode,
                                                           String distributionAmountCode)
                                                                throws Exception

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

distributionAmountCode -

Returns:

An ActionForward

Throws:

Exception

getRuleService

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

Get the rule service

Returns:

ruleService