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

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.EndowmentAccountingLinesDocumentActionBase

Direct Known Subclasses:

EndowmentToGLTransferOfFundsDocumentAction, GLToEndowmentTransferOfFundsDocumentAction

public class EndowmentAccountingLinesDocumentActionBase
extends EndowmentTransactionLinesDocumentActionBase

Field Summary

protected static org.apache.log4j.Logger

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

EndowmentAccountingLinesDocumentActionBase()

Method Summary

protected void	checkUploadFile(org.apache.struts.upload.FormFile file) This method...
protected void	deleteAccountingLine(boolean isSource, EndowmentAccountingLinesDocumentFormBase etlDocumentForm, int index) Deletes a Accounting Line.
org.apache.struts.action.ActionForward	deleteSourceAccountingLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This action deletes an EndowmentSourceAccountingLine from a document.
org.apache.struts.action.ActionForward	deleteTargetAccountingLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This action deletes an EndowmentTargetAccountingLine from a document.
protected void	insertAccountingLine(boolean isSource, EndowmentAccountingLinesDocumentFormBase etaDocumentForm, EndowmentAccountingLine line) Adds the given accountingLine to the appropriate form-related data structures.
org.apache.struts.action.ActionForward	insertSourceAccountingLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This action executes an insert of an SourceEndowmentAccountingLine into a document only after validating the Accounting line and checking any appropriate business rules.
org.apache.struts.action.ActionForward	insertTargetAccountingLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This action executes an insert of an TargetEndowmentAccountingLine into a document only after validating the Accounting line and checking any appropriate business rules.
org.apache.struts.action.ActionForward	performBalanceInquiry(boolean isSource, org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method provides the KEMIDCurrentBalance as the default lookup object.
org.apache.struts.action.ActionForward	performBalanceInquiry(boolean isSource, String boName, org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method is similar to org.kuali.kfs.sys.web.struts.KualiAccountingDocumentActionBase.performBalanceInquiry()
org.apache.struts.action.ActionForward	performBalanceInquiryForSourceAccountingLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method returns the balance inquiry for source accounting lines.
org.apache.struts.action.ActionForward	performBalanceInquiryForTargetAccountingLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method returns the balance inquiry for target accounting lines.
protected void	uploadAccountingLines(boolean isSource, org.apache.struts.action.ActionForm form) This method determines whether we are uploading source or target lines, and then calls uploadAccountingLines directly on the document object.
org.apache.struts.action.ActionForward	uploadSourceLines(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This action executes a call to upload CSV accounting line values as SourceAccountingLines for a given transactional document.
org.apache.struts.action.ActionForward	uploadTargetLines(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This action executes a call to upload CSV accounting line values as TargetAccountingLines for a given transactional document.

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

cancelImport, deleteSourceTransactionLine, deleteTargetTransactionLine, deleteTransactionLine, importSourceTransactionLines, importTargetTransactionLines, importTransactionLines, insertSourceTransactionLine, insertTargetTransactionLine, insertTransactionLine, loadDocument, 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, route, save, 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

Field Detail

log

protected static org.apache.log4j.Logger log

Constructor Detail

EndowmentAccountingLinesDocumentActionBase

public EndowmentAccountingLinesDocumentActionBase()

Method Detail

insertTargetAccountingLine

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

This action executes an insert of an TargetEndowmentAccountingLine into a document only after validating the Accounting line and checking any appropriate business rules.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

insertSourceAccountingLine

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

This action executes an insert of an SourceEndowmentAccountingLine into a document only after validating the Accounting line and checking any appropriate business rules.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

insertAccountingLine

protected void insertAccountingLine(boolean isSource,
                                    EndowmentAccountingLinesDocumentFormBase etaDocumentForm,
                                    EndowmentAccountingLine line)

Adds the given accountingLine to the appropriate form-related data structures.

Parameters:

isSource -

etlDocumentForm -

line -

deleteSourceAccountingLine

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

This action deletes an EndowmentSourceAccountingLine from a document.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

deleteTargetAccountingLine

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

This action deletes an EndowmentTargetAccountingLine from a document.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

deleteAccountingLine

protected void deleteAccountingLine(boolean isSource,
                                    EndowmentAccountingLinesDocumentFormBase etlDocumentForm,
                                    int index)

Deletes a Accounting Line.

Parameters:

isSource -

etlDocumentForm -

index -

performBalanceInquiryForTargetAccountingLine

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

This method returns the balance inquiry for target accounting lines.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

performBalanceInquiryForSourceAccountingLine

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

This method returns the balance inquiry for source accounting lines.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

performBalanceInquiry

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

This method provides the KEMIDCurrentBalance as the default lookup object. If a different lookup is needed this method should be overriden.

Overrides:

performBalanceInquiry in class EndowmentTransactionLinesDocumentActionBase

Parameters:

isSource -

mapping -

form -

request -

response -

Returns:

Throws:

Exception

performBalanceInquiry

public org.apache.struts.action.ActionForward performBalanceInquiry(boolean isSource,
                                                                    String boName,
                                                                    org.apache.struts.action.ActionMapping mapping,
                                                                    org.apache.struts.action.ActionForm form,
                                                                    javax.servlet.http.HttpServletRequest request,
                                                                    javax.servlet.http.HttpServletResponse response)
                                                             throws Exception

This method is similar to org.kuali.kfs.sys.web.struts.KualiAccountingDocumentActionBase.performBalanceInquiry()

Overrides:

performBalanceInquiry in class EndowmentTransactionLinesDocumentActionBase

Parameters:

isRevenue -

mapping -

form -

request -

response -

Returns:

Throws:

Exception

uploadTargetLines

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

This action executes a call to upload CSV accounting line values as TargetAccountingLines for a given transactional document. The "uploadAccountingLines()" method handles the multi-part request.

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

uploadSourceLines

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

This action executes a call to upload CSV accounting line values as SourceAccountingLines for a given transactional document. The "uploadAccountingLines()" method handles the multi-part request.

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

FileNotFoundException

IOException

uploadAccountingLines

protected void uploadAccountingLines(boolean isSource,
                                     org.apache.struts.action.ActionForm form)
                              throws FileNotFoundException,
                                     IOException

This method determines whether we are uploading source or target lines, and then calls uploadAccountingLines directly on the document object. This method handles retrieving the actual upload file as an input stream into the document.

Parameters:

isSource -

form -

Throws:

FileNotFoundException

IOException

checkUploadFile

protected void checkUploadFile(org.apache.struts.upload.FormFile file)

This method...

Parameters:

file -