org.kuali.kfs.module.endow.document.web.struts
Class EndowmentTaxLotLinesDocumentActionBase

java.lang.Object
  org.apache.struts.action.Action
      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.module.endow.document.web.struts.EndowmentTransactionLinesDocumentActionBase
                              org.kuali.kfs.module.endow.document.web.struts.EndowmentTaxLotLinesDocumentActionBase

Direct Known Subclasses:

AssetDecreaseDocumentAction, AssetIncreaseDocumentAction, CorporateReorganizationDocumentAction, EndowmentUnitShareAdjustmentDocumentAction, HoldingAdjustmentDocumentAction, LiabilityDecreaseDocumentAction, LiabilityIncreaseDocumentAction, SecurityTransferDocumentAction

public abstract class EndowmentTaxLotLinesDocumentActionBase
extends EndowmentTransactionLinesDocumentActionBase

Field Summary

Fields inherited from class org.kuali.kfs.module.endow.document.web.struts.EndowmentTransactionLinesDocumentActionBase

log

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, messages, methods, types

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

defaultLocale, servlet

Constructor Summary

EndowmentTaxLotLinesDocumentActionBase()

Method Summary

org.apache.struts.action.ActionForward	deleteSourceTaxLotLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deletes a source tax lot line.
org.apache.struts.action.ActionForward	deleteTargetTaxLotLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deletes a target tax lot line
protected abstract boolean	getRefreshTaxLotsOnSaveOrSubmit() Tells whether the tax lot lines related to the transaction lines should be refreshed on save or submit.
protected int	getTaxLotToDelete(javax.servlet.http.HttpServletRequest request) Gets the index of the tax lot line to be deleted.
protected void	insertTransactionLine(boolean isSource, EndowmentTransactionLinesDocumentFormBase etlDocumentForm, EndowmentTransactionLine line) Adds the given transactionLine to the appropriate form-related datastructures.
org.apache.struts.action.ActionForward	refreshSourceTaxLots(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Refreshes the tax lots for the selected source transaction line.
org.apache.struts.action.ActionForward	refreshTargetTaxLots(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Refreshes the tax lots for the selected target transaction line.
org.apache.struts.action.ActionForward	route(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	save(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	updateTaxLots(EndowmentTransactionLinesDocument etlDocument) Updates the tax lots for the given document.
protected abstract void	updateTransactionLineTaxLots(boolean isUpdate, boolean isSource, EndowmentTransactionLinesDocument etlDocument, EndowmentTransactionLine transLine) Updates the tax lots for the given transaction line.

Methods inherited from class org.kuali.kfs.module.endow.document.web.struts.EndowmentTransactionLinesDocumentActionBase

cancelImport, deleteSourceTransactionLine, deleteTargetTransactionLine, deleteTransactionLine, importSourceTransactionLines, importTargetTransactionLines, importTransactionLines, insertSourceTransactionLine, insertTargetTransactionLine, loadDocument, performBalanceInquiry, performBalanceInquiry, performBalanceInquiryForSourceTransactionLine, performBalanceInquiryForTargetTransactionLine, refresh, refreshRegistrationDetails, refreshSecurityDetails

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

correct

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

copy, populateAuthorizationFields

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

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

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

addMethodToCallToUncheckedList, defaultDispatch, dispatchMethod, findMethodToCall, getApplicationBaseUrl, getBasePath, getEncryptionService, getHeaderTabDispatch, getHeaderTabNavigateTo, getImageContext, getKualiModuleService, getLineToDelete, getReturnLocation, getRoleQualification, getSelectedLine, getTabToToggle, headerTab, performInquiry, performLookup, 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, getDataSource, getDataSource, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, 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

EndowmentTaxLotLinesDocumentActionBase

public EndowmentTaxLotLinesDocumentActionBase()

Method Detail

updateTransactionLineTaxLots

protected abstract void updateTransactionLineTaxLots(boolean isUpdate,
                                                     boolean isSource,
                                                     EndowmentTransactionLinesDocument etlDocument,
                                                     EndowmentTransactionLine transLine)

Updates the tax lots for the given transaction line.

Parameters:

isSource -

etlDocument -

transLine -

updateTaxLots

protected void updateTaxLots(EndowmentTransactionLinesDocument etlDocument)

Updates the tax lots for the given document.

Parameters:

isSource -

etlDocument -

refreshTargetTaxLots

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

Refreshes the tax lots for the selected target transaction line.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

refreshSourceTaxLots

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

Refreshes the tax lots for the selected source transaction line.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

insertTransactionLine

protected void insertTransactionLine(boolean isSource,
                                     EndowmentTransactionLinesDocumentFormBase etlDocumentForm,
                                     EndowmentTransactionLine line)

Description copied from class: EndowmentTransactionLinesDocumentActionBase

Adds the given transactionLine to the appropriate form-related datastructures.

Overrides:

insertTransactionLine in class EndowmentTransactionLinesDocumentActionBase

See Also:

EndowmentTransactionLinesDocumentActionBase.insertTransactionLine(boolean, org.kuali.kfs.module.endow.document.web.struts.EndowmentTransactionLinesDocumentFormBase, org.kuali.kfs.module.endow.businessobject.EndowmentTransactionLine)

deleteSourceTaxLotLine

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

Deletes a source tax lot line.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

deleteTargetTaxLotLine

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

Deletes a target tax lot line

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

getTaxLotToDelete

protected int getTaxLotToDelete(javax.servlet.http.HttpServletRequest request)

Gets the index of the tax lot line to be deleted.

Parameters:

request -

Returns:

the index of the tax lot line to be deleted

save

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

Overrides:

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

Throws:

Exception

See Also:

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

route

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

Overrides:

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

Throws:

Exception

See Also:

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

getRefreshTaxLotsOnSaveOrSubmit

protected abstract boolean getRefreshTaxLotsOnSaveOrSubmit()

Tells whether the tax lot lines related to the transaction lines should be refreshed on save or submit. For documents that support tax lots deletion this method should return false. For documents that do not support tax lots deletion this method can return true so that the tax lots are updated on save or submit.

Returns:

true or false depending on the document