org.kuali.kfs.module.purap.document.web.struts
Class PurchasingActionBase

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.sys.web.struts.KualiAccountingDocumentActionBase
                              org.kuali.kfs.module.purap.document.web.struts.PurchasingAccountsPayableActionBase
                                  org.kuali.kfs.module.purap.document.web.struts.PurchasingActionBase

Direct Known Subclasses:

PurchaseOrderAction, RequisitionAction

public class PurchasingActionBase
extends PurchasingAccountsPayableActionBase

Struts Action for Purchasing documents.

Field Summary

protected static org.apache.log4j.Logger

LOG

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

UPDATE_EVENT_ACTIONS

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

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

defaultLocale, servlet

Constructor Summary

PurchasingActionBase()

Method Summary

org.apache.struts.action.ActionForward	addCapitalAssetLocationByDocument(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	addCapitalAssetLocationByItem(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	addItem(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Add a new item to the document.
org.apache.struts.action.ActionForward	addItemCapitalAssetByDocument(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	addItemCapitalAssetByItem(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	approve(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Overrides the superclass method so that it will also do proration for trade in and full order discount when the user clicks on the approve button.
org.apache.struts.action.ActionForward	blanketApprove(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	calculate(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Perform calculation on item line.
org.apache.struts.action.ActionForward	cancelAccountDistribution(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Simply hides the account distribution section.
org.apache.struts.action.ActionForward	changeSystem(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	clearAllTaxes(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	clearItemsCommodityCodes(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Clear out the commodity codes from all the items.
org.apache.struts.action.ActionForward	clearNotCurrentYearByDocument(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	clearNotCurrentYearByItem(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected SourceAccountingLine	customAccountRetrieval(int accountIndex, PurchasingAccountsPayableFormBase purchasingAccountsPayableForm) Sets the line for account distribution.
org.apache.struts.action.ActionForward	deleteCapitalAssetLocationByDocument(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	deleteCapitalAssetLocationByItem(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	deleteItem(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Delete an item from the document.
org.apache.struts.action.ActionForward	deleteItemCapitalAssetByDocument(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	deleteItemCapitalAssetByItem(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	deleteSourceLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method will remove a SourceAccountingLine from a FinancialDocument.
org.apache.struts.action.ActionForward	doDistribution(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Distribute accounting line(s) to the item(s).
org.apache.struts.action.ActionForward	downItem(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Moves the selected item down one position (These two methods up/down could easily be consolidated.
protected String	findBuildingCodeFromCapitalAssetBuildingLookup(javax.servlet.http.HttpServletRequest request) Determine from request parameters if user is returning from capital asset building lookup.
protected String	getCaptialAssetItemNumberFromParameter(String parameterKey)
protected String	getCaptialAssetLocationNumberFromParameter(String parameterKey)
org.apache.struts.action.ActionForward	importItems(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Import items to the document from a spreadsheet.
protected void	loadDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase kualiDocumentFormBase) All document-load operations get routed through here
boolean	processCustomInsertAccountingLine(PurchasingAccountsPayableFormBase purapForm, javax.servlet.http.HttpServletRequest request) Allows the custom processing of an accounting line during a call to insert source line.
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) Needed to override this to keep from losing Sales Tax information
org.apache.struts.action.ActionForward	removeAccounts(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Clear out the accounting lines from all the items.
protected boolean	requiresCalculate(PurchasingFormBase purForm) Checks if calculation is required.
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) Overrides the superclass method so that it will also do proration for trade in and full order discount when the user clicks on the submit button.
org.apache.struts.action.ActionForward	selectNotCurrentYearByDocument(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	selectNotCurrentYearByItem(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	selectSystem(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	selectSystemType(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method...
org.apache.struts.action.ActionForward	setManufacturerFromVendorByDocument(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	setManufacturerFromVendorByItem(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	setupAccountDistribution(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Reveals the account distribution section.
org.apache.struts.action.ActionForward	setupCAMSSystem(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	updateBOReferenceforNewItems(List<PurApItem> importedItems, PurchasingDocumentBase purDocument) Whenever add a new item, we need to keep track of the reference from Item to Doc and from Account to Item
org.apache.struts.action.ActionForward	updateCamsView(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	upItem(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Moves the selected item up one position.
protected void	useOffCampusAssetLocationBuilding(CapitalAssetLocation location)
org.apache.struts.action.ActionForward	useOffCampusAssetLocationBuildingByDocument(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	useOffCampusAssetLocationBuildingByItem(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	useOtherDeliveryBuilding(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Setup document to use "OTHER" building
protected boolean	validateDistributeAccounts(org.kuali.rice.kns.document.Document document, List<PurApAccountingLine> distributionsourceAccountingLines) Validates that the accounting lines while a distribute accounts action is being taken.

Methods inherited from class org.kuali.kfs.module.purap.document.web.struts.PurchasingAccountsPayableActionBase

customCalculate, downloadBOAttachment, getSelectedLineForAccounts, getSourceAccountingLine, hideAllAccounts, insertAccountingLine, insertAccountingLine, insertBONote, insertSourceLine, processAccountingLineOverrides, refreshAccountSummary, showAllAccounts, updateBaseline, uploadAccountingLines

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

addCapitalAssetInfo, addCapitalAssetInfoDetailLines, applyCapitalAssetInformation, checkSalesTax, checkSalesTaxRequiredAllLines, checkUploadFile, clearCapitalAssetInfo, clearOverridesThatBecameUnneeded, copy, deepCopyAccountingLinesList, deleteAccountingLine, deleteCapitalAssetInfoDetailLine, deleteTargetLine, execute, getCurrentCapitalAssetInformationObject, getMaxItemLineNumber, getNextItemLineNumberAndIncremented, getObjectTypeCodeFromLine, getTargetAccountingLine, handleSalesTaxRequired, handleSalesTaxRequiredAllLines, hasSalesTaxBeenEntered, hideDetails, insertAccountingLine, insertTargetLine, isSalesTaxRequired, isValidSalesTaxEntered, performBalanceInquiryForAccountingLine, performBalanceInquiryForSourceLine, performBalanceInquiryForTargetLine, performLookup, populateSalesTax, processAccountingLineOverrides, processAccountingLineOverrides, processAccountingLines, refreshSalesTaxInfo, removeSalesTax, resetCapitalAssetInfo, save, showDetails, toggleTab, uploadSourceLines, uploadTargetLines

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

populateAuthorizationFields

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

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

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, 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

PurchasingActionBase

public PurchasingActionBase()

Method Detail

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

Description copied from class: KualiAccountingDocumentActionBase

Needed to override this to keep from losing Sales Tax information

Overrides:

refresh in class KualiAccountingDocumentActionBase

Throws:

Exception

See Also:

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

getCaptialAssetLocationNumberFromParameter

protected String getCaptialAssetLocationNumberFromParameter(String parameterKey)

getCaptialAssetItemNumberFromParameter

protected String getCaptialAssetItemNumberFromParameter(String parameterKey)

useOtherDeliveryBuilding

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

Setup document to use "OTHER" building

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - A HttpServletRequest

response - A HttpServletResponse

Returns:

An ActionForward

Throws:

Exception

useOffCampusAssetLocationBuildingByDocument

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

Throws:

Exception

useOffCampusAssetLocationBuildingByItem

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

Throws:

Exception

useOffCampusAssetLocationBuilding

protected void useOffCampusAssetLocationBuilding(CapitalAssetLocation location)

addItem

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

Add a new item to the document.

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

Returns:

An ActionForward

Throws:

Exception

importItems

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

Import items to the document from a spreadsheet.

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

Returns:

An ActionForward

Throws:

Exception

updateBOReferenceforNewItems

protected void updateBOReferenceforNewItems(List<PurApItem> importedItems,
                                            PurchasingDocumentBase purDocument)

Whenever add a new item, we need to keep track of the reference from Item to Doc and from Account to Item

Parameters:

importedItems -

deleteItem

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

Delete an item from the document.

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

Returns:

An ActionForward

Throws:

Exception

upItem

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

Moves the selected item up one position.

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

Returns:

An ActionForward

Throws:

Exception

downItem

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

Moves the selected item down one position (These two methods up/down could easily be consolidated. For now, it seems more straightforward to keep them separate.)

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

Returns:

An ActionForward

Throws:

Exception

setupAccountDistribution

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

Reveals the account distribution section.

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

Returns:

An ActionForward

Throws:

Exception

removeAccounts

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

Clear out the accounting lines from all the items.

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

Returns:

An ActionForward

Throws:

Exception

clearItemsCommodityCodes

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

Clear out the commodity codes from all the items.

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

Returns:

An ActionForward

Throws:

Exception

validateDistributeAccounts

protected boolean validateDistributeAccounts(org.kuali.rice.kns.document.Document document,
                                             List<PurApAccountingLine> distributionsourceAccountingLines)

Validates that the accounting lines while a distribute accounts action is being taken.

Parameters:

document -

distributionsourceAccountingLines -

Returns:

doDistribution

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

Distribute accounting line(s) to the item(s). Does not distribute the accounting line(s) to an item if there are already accounting lines associated with that item, if the item is a below-the-line item and has no unit cost, or if the item is inactive. Distribute commodity code to the item(s). Does not distribute the commodity code to an item if the item is not above the line item, is inactive or if the commodity code fails the validation (i.e. inactive commodity code or non existence commodity code).

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

Returns:

An ActionForward

Throws:

Exception

cancelAccountDistribution

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

Simply hides the account distribution section.

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

Returns:

An ActionForward

Throws:

Exception

processCustomInsertAccountingLine

public boolean processCustomInsertAccountingLine(PurchasingAccountsPayableFormBase purapForm,
                                                 javax.servlet.http.HttpServletRequest request)

Description copied from class: PurchasingAccountsPayableActionBase

Allows the custom processing of an accounting line during a call to insert source line. If a custom method for inserting an accounting line was performed, then a value of true must be returned.

Overrides:

processCustomInsertAccountingLine in class PurchasingAccountsPayableActionBase

Returns:

boolean indicating if validation succeeded

See Also:

org.kuali.kfs.module.purap.document.web.struts.PurchasingAccountsPayableActionBase#processCustomInsertAccountingLine(org.kuali.kfs.module.purap.document.web.struts.PurchasingAccountsPayableFormBase)

deleteSourceLine

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

Description copied from class: KualiAccountingDocumentActionBase

This method will remove a SourceAccountingLine from a FinancialDocument. This assumes that the user presses the delete button for a specific accounting line on the document and that the document is represented by a FinancialDocumentFormBase.

Overrides:

deleteSourceLine in class PurchasingAccountsPayableActionBase

Returns:

ActionForward

Throws:

Exception

See Also:

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

customAccountRetrieval

protected SourceAccountingLine customAccountRetrieval(int accountIndex,
                                                      PurchasingAccountsPayableFormBase purchasingAccountsPayableForm)

Sets the line for account distribution.

Overrides:

customAccountRetrieval in class PurchasingAccountsPayableActionBase

Parameters:

accountIndex - The index of the account into the request parameter

purchasingAccountsPayableForm - A form which inherits from PurchasingAccountsPayableFormBase

Returns:

A SourceAccountingLine

selectSystemType

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

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

addItemCapitalAssetByDocument

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

Throws:

Exception

addItemCapitalAssetByItem

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

Throws:

Exception

deleteItemCapitalAssetByDocument

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

Throws:

Exception

deleteItemCapitalAssetByItem

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

Throws:

Exception

addCapitalAssetLocationByDocument

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

Throws:

Exception

addCapitalAssetLocationByItem

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

Throws:

Exception

deleteCapitalAssetLocationByDocument

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

Throws:

Exception

deleteCapitalAssetLocationByItem

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

Throws:

Exception

setupCAMSSystem

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

Throws:

Exception

selectSystem

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

Throws:

Exception

changeSystem

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

Throws:

Exception

updateCamsView

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

Throws:

Exception

setManufacturerFromVendorByDocument

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

Throws:

Exception

setManufacturerFromVendorByItem

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

Throws:

Exception

selectNotCurrentYearByDocument

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

Throws:

Exception

selectNotCurrentYearByItem

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

Throws:

Exception

clearNotCurrentYearByDocument

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

Throws:

Exception

clearNotCurrentYearByItem

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

Throws:

Exception

calculate

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

Description copied from class: PurchasingAccountsPayableActionBase

Perform calculation on item line.

Overrides:

calculate in class PurchasingAccountsPayableActionBase

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

Returns:

An ActionForward

Throws:

Exception

loadDocument

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

Description copied from class: KualiAccountingDocumentActionBase

All document-load operations get routed through here

Overrides:

loadDocument in class PurchasingAccountsPayableActionBase

Throws:

org.kuali.rice.kew.exception.WorkflowException

See Also:

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

clearAllTaxes

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

clearAllTaxes in class PurchasingAccountsPayableActionBase

Throws:

Exception

findBuildingCodeFromCapitalAssetBuildingLookup

protected String findBuildingCodeFromCapitalAssetBuildingLookup(javax.servlet.http.HttpServletRequest request)

Determine from request parameters if user is returning from capital asset building lookup. Parameter will start with either document.purchasingCapitalAssetItems or document.purchasingCapitalAssetSystems

Parameters:

request -

Returns:

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 the superclass method so that it will also do proration for trade in and full order discount when the user clicks on the submit button.

Overrides:

route in class KualiAccountingDocumentActionBase

Throws:

Exception

See Also:

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

approve

public org.apache.struts.action.ActionForward approve(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 the superclass method so that it will also do proration for trade in and full order discount when the user clicks on the approve button.

Overrides:

approve in class KualiAccountingDocumentActionBase

Throws:

Exception

See Also:

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

blanketApprove

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

blanketApprove in class KualiAccountingDocumentActionBase

Throws:

Exception

requiresCalculate

protected boolean requiresCalculate(PurchasingFormBase purForm)

Checks if calculation is required. Currently it is required when it has not already been calculated and if the user can perform calculate

Returns:

true if calculation is required, false otherwise