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

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

Direct Known Subclasses:

CashDocumentActionBase, CorpusAdjustmentDocumentAction, EndowmentAccountingLinesDocumentActionBase, EndowmentTaxLotLinesDocumentActionBase

public abstract class EndowmentTransactionLinesDocumentActionBase
extends FinancialSystemTransactionalDocumentActionBase

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

EndowmentTransactionLinesDocumentActionBase()

Method Summary

org.apache.struts.action.ActionForward	cancelImport(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Cancels import.
org.apache.struts.action.ActionForward	deleteSourceTransactionLine(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 EndowmentSourceTransactionLine from a document.
org.apache.struts.action.ActionForward	deleteTargetTransactionLine(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 EndowmentTargetTransactionLine from a document.
protected void	deleteTransactionLine(boolean isSource, EndowmentTransactionLinesDocumentFormBase etlDocumentForm, int index) Deletes a Transaction Line.
org.apache.struts.action.ActionForward	importSourceTransactionLines(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	importTargetTransactionLines(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	importTransactionLines(boolean isSource, org.apache.struts.action.ActionForm form)
org.apache.struts.action.ActionForward	insertSourceTransactionLine(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 EndowmentTargetTransactionLine into a document only after validating the Transaction line and checking any appropriate business rules.
org.apache.struts.action.ActionForward	insertTargetTransactionLine(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 EndowmentTargetTransactionLine into a document only after validating the Transaction line and checking any appropriate business rules.
protected void	insertTransactionLine(boolean isSource, EndowmentTransactionLinesDocumentFormBase etlDocumentForm, EndowmentTransactionLine line) Adds the given transactionLine to the appropriate form-related datastructures.
protected void	loadDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase kualiDocumentFormBase)
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	performBalanceInquiryForSourceTransactionLine(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 transaction lines.
org.apache.struts.action.ActionForward	performBalanceInquiryForTargetTransactionLine(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 transaction lines.
org.apache.struts.action.ActionForward	refresh(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	refreshRegistrationDetails(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Retrieves and sets the reference RegistrationCode object on Source or Target transactionsecurity based on the looked up value.
org.apache.struts.action.ActionForward	refreshSecurityDetails(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Retrieves and sets the reference Security object on Source or Target transactionsecurity based on the looked up value.

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

EndowmentTransactionLinesDocumentActionBase

public EndowmentTransactionLinesDocumentActionBase()

Method Detail

loadDocument

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

Overrides:

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

Throws:

org.kuali.rice.kew.exception.WorkflowException

See Also:

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

importSourceTransactionLines

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

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

importTargetTransactionLines

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

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

cancelImport

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

Cancels import.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

importTransactionLines

public void importTransactionLines(boolean isSource,
                                   org.apache.struts.action.ActionForm form)
                            throws Exception

Parameters:

mapping -

form -

request -

response -

Throws:

Exception

insertTargetTransactionLine

public org.apache.struts.action.ActionForward insertTargetTransactionLine(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 EndowmentTargetTransactionLine into a document only after validating the Transaction line and checking any appropriate business rules.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

insertSourceTransactionLine

public org.apache.struts.action.ActionForward insertSourceTransactionLine(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 EndowmentTargetTransactionLine into a document only after validating the Transaction line and checking any appropriate business rules.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

insertTransactionLine

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

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

Parameters:

isSource -

etlDocumentForm -

line -

deleteSourceTransactionLine

public org.apache.struts.action.ActionForward deleteSourceTransactionLine(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 EndowmentSourceTransactionLine from a document.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

deleteTargetTransactionLine

public org.apache.struts.action.ActionForward deleteTargetTransactionLine(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 EndowmentTargetTransactionLine from a document.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

deleteTransactionLine

protected void deleteTransactionLine(boolean isSource,
                                     EndowmentTransactionLinesDocumentFormBase etlDocumentForm,
                                     int index)

Deletes a Transaction Line.

Parameters:

isSource -

etlDocumentForm -

index -

refresh

public org.apache.struts.action.ActionForward refresh(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:

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

Throws:

Exception

See Also:

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

refreshSecurityDetails

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

Retrieves and sets the reference Security object on Source or Target transactionsecurity based on the looked up value.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

refreshRegistrationDetails

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

Retrieves and sets the reference RegistrationCode object on Source or Target transactionsecurity based on the looked up value.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

performBalanceInquiryForTargetTransactionLine

public org.apache.struts.action.ActionForward performBalanceInquiryForTargetTransactionLine(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 transaction lines.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

performBalanceInquiryForSourceTransactionLine

public org.apache.struts.action.ActionForward performBalanceInquiryForSourceTransactionLine(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 transaction 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.

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()

Parameters:

isRevenue -

mapping -

form -

request -

response -

Returns:

Throws:

Exception