org.kuali.ole.fp.document.web.struts

Class CashReceiptAction

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.ole.sys.document.web.struts.FinancialSystemTransactionalDocumentActionBase

org.kuali.ole.sys.web.struts.KualiAccountingDocumentActionBase

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

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

org.kuali.ole.fp.document.web.struts.CashReceiptAction

public class CashReceiptAction
extends CapitalAccountingLinesActionBase

Field Summary

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

LOG

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

UPDATE_EVENT_ACTIONS

Fields inherited from class org.kuali.ole.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
CashReceiptAction()

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.struts.action.ActionForward	addCheck(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Adds Check instance created from the current "new check" line to the document
org.apache.struts.action.ActionForward	addConfirmedCheck(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Adds confirmed Check instance created from the current "new check" line to the document
org.apache.struts.action.ActionForward	changeCheckEntryMode(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Changes the current check-entry mode, if necessary
org.apache.struts.action.ActionForward	copy(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Overridden to guarantee that form of copied document is set to whatever the entry mode of the document is
org.apache.struts.action.ActionForward	copyAllChecks(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Copy all original checks to cash manager confirmed checks
org.apache.struts.action.ActionForward	copyAllCurrencyAndCoin(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Copy all original currency and coin to cash manager confirmed currency and coin
protected void	createDocument(KualiDocumentFormBase kualiDocumentFormBase)
org.apache.struts.action.ActionForward	deleteCheck(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deletes the selected check (line) from the document
org.apache.struts.action.ActionForward	deleteConfirmedCheck(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deletes the selected check (line) from the document
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) Adds handling for check updates
protected void	initDerivedCheckValues(CashReceiptForm cform) Initializes form values which must be derived form document contents (i.e.
protected void	loadDocument(KualiDocumentFormBase kualiDocumentFormBase) All document-load operations get routed through here
org.apache.struts.action.ActionForward	printCoverSheet(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Prepares and streams CR PDF Cover Sheet
protected void	processCheckEntryMode(CashReceiptForm crForm, CashReceiptDocument crDoc) This method processes the check entry mode to determine if the user is entering checks or if they are just entering the total.
protected void	processChecks(CashReceiptDocument cdoc, CashReceiptForm cform) This method handles iterating over the check list and generating check events to apply rules to.

Methods inherited from class org.kuali.ole.fp.document.web.struts.CapitalAccountingLinesActionBase

addCapitalAccountingLine, capitalAccountingLinesSelected, checkDistributedAccountingLineExists, checkObjecSubTypeCrossingCapitalAccountingLines, correct, createAsset, createCapitalAccountingLine, createCapitalAccountingLines, createCapitalAssetsForSelectedAccountingLines, deleteAccountingLine, deleteCapitalAccountingLine, getRuleService, insertAccountingLine, modifyAsset, performQuestionPrompt, refresh, removeOrphanCapitalAccountingLine, removeOrphanCapitalAccountingLines, removeOrphanDisributedAccountingLine, removeOrphanDisributedAccountingLines, sortCaptitalAccountingLines, updateCapitalAccountingLine, updateCapitalAccountingLines, uploadAccountingLines

Methods inherited from class org.kuali.ole.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, 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, refreshCapitalAssetModify, removeDistributedAccountingLine, removeEmptyCapitalAssetModify, resetCapitalAssetInfo, setTabStatesForCapitalAssets, setupIntialNextCapitalAssetLineNumber, uncheckCapitalAccountingLinesSelected

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

approve, blanketApprove, checkSalesTax, checkSalesTaxRequiredAllLines, checkUploadFile, deepCopyAccountingLinesList, 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, uploadSourceLines, uploadTargetLines

Methods inherited from class org.kuali.ole.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, delete, deleteAdHocRoutePerson, deleteAdHocRouteWorkgroup, deleteBONote, determineNoteWorkflowNotificationAction, disapprove, docHandler, 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

CashReceiptAction

public CashReceiptAction()

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

Adds handling for check updates

Overrides:

execute in class KualiAccountingDocumentActionBase

Throws:

Exception

See Also:

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

printCoverSheet

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

Prepares and streams CR PDF Cover Sheet

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

processCheckEntryMode

protected void processCheckEntryMode(CashReceiptForm crForm,
                         CashReceiptDocument crDoc)

This method processes the check entry mode to determine if the user is entering checks or if they are just entering the total.

Parameters:

crForm -

crDoc -

processChecks

protected void processChecks(CashReceiptDocument cdoc,
                 CashReceiptForm cform)

This method handles iterating over the check list and generating check events to apply rules to.

Parameters:

cdoc -

cform -

addCheck

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

Adds Check instance created from the current "new check" line to the document

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

addConfirmedCheck

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

Adds confirmed Check instance created from the current "new check" line to the document

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

deleteCheck

public org.apache.struts.action.ActionForward deleteCheck(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 the selected check (line) from the document

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

deleteConfirmedCheck

public org.apache.struts.action.ActionForward deleteConfirmedCheck(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 the selected check (line) from the document

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

changeCheckEntryMode

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

Changes the current check-entry mode, if necessary

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

createDocument

protected void createDocument(KualiDocumentFormBase kualiDocumentFormBase)
                       throws org.kuali.rice.kew.api.exception.WorkflowException

Overrides:

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

Throws:

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

See Also:

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

loadDocument

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

Description copied from class: CapitalAccountingLinesActionBase

All document-load operations get routed through here

Overrides:

loadDocument in class CapitalAccountingLinesActionBase

Throws:

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

See Also:

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

copyAllChecks

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

Copy all original checks to cash manager confirmed checks

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

copyAllCurrencyAndCoin

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

Copy all original currency and coin to cash manager confirmed currency and coin

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

initDerivedCheckValues

protected void initDerivedCheckValues(CashReceiptForm cform)

Initializes form values which must be derived form document contents (i.e. those which aren't directly available from the document)

Parameters:

cform -

copy

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

Overridden to guarantee that form of copied document is set to whatever the entry mode of the document is

Overrides:

copy in class CapitalAssetInformationActionBase

Throws:

Exception

See Also:

KualiTransactionalDocumentActionBase.copy(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)