org.kuali.kfs.gl.document.web.struts
Class CorrectionAction

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.kfs.gl.document.web.struts.CorrectionAction

All Implemented Interfaces:

org.kuali.rice.kns.web.struts.action.KualiTableRenderAction

Direct Known Subclasses:

LaborCorrectionAction

public class CorrectionAction
extends org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase
implements org.kuali.rice.kns.web.struts.action.KualiTableRenderAction

Field Summary

protected static org.kuali.rice.kns.service.DateTimeService	dateTimeService
protected static org.kuali.rice.kns.service.KualiConfigurationService	kualiConfigurationService
protected static org.apache.log4j.Logger	LOG
protected static OriginEntryGroupService	originEntryGroupService
protected static OriginEntryService	originEntryService
static String	SYSTEM_AND_EDIT_METHOD_ERROR_KEY

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

CorrectionAction()

Method Summary

org.apache.struts.action.ActionForward	addCorrectionChange(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 correction change to the specified group
org.apache.struts.action.ActionForward	addCorrectionCriteria(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 correction criteria to the specified group
org.apache.struts.action.ActionForward	addCorrectionGroup(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Add a correction group
org.apache.struts.action.ActionForward	addManualEntry(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 row to the group
protected void	applyCriteriaOnEntries(Collection<OriginEntryFull> entries, boolean matchCriteriaOnly, List<CorrectionChangeGroup> changeCriteriaGroups) For criteria based edits, this method will generate the output group
protected void	applyPagingAndSortingFromPreviousPageView(CorrectionForm correctionForm)
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)
void	buildTextOutputfile(ByteArrayOutputStream bw, BufferedReader br)
protected boolean	checkInputGroupPersistedForDocumentSave(CorrectionForm correctionForm) Checks whether this document has the input group still persisted in the database.
protected boolean	checkMainDropdown(CorrectionForm errorCorrectionForm) Validate that choose system and edit method are selected
protected boolean	checkOriginEntryGroupSelection(CorrectionForm correctionForm) This method checks that an origin entry group has been selected; and this method is intended to be used for selecting an origin entry group when using the database method If a group has not been loaded, then an error will be added to the screen
protected boolean	checkOriginEntryGroupSelectionBeforeRouting(GeneralLedgerCorrectionProcessDocument document) This method checks that an origin entry group has been selected or uploaded, depending on the system of the document If a group has not been loaded, then an error will be added to the screen
protected boolean	checkRestrictedFunctionalityModeForManualEdit(CorrectionForm correctionForm) This method puts an error in the error map indicating that manual edit-ing GLCP docs may not be in restrictedFunctionalityMode, if appropriate (Since we can't view results in this mode, we can't manually edit them)
org.apache.struts.action.ActionForward	close(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This needs to be done just in case they decide to save it when closing.
org.apache.struts.action.ActionForward	confirmDeleteDocument(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Called when a group is selected to be deleted
org.apache.struts.action.ActionForward	deleteManualEntry(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Delete a row from the group
org.apache.struts.action.ActionForward	docHandler(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Called when the document is loaded from action list or doc search or a new document is created.
org.apache.struts.action.ActionForward	editManualEntry(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Edit a row in the group
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)
protected int	getMaxEntryId(List<OriginEntryFull> entryList)
protected void	loadAllEntries(List<OriginEntryFull> searchResults, CorrectionForm correctionForm)
protected void	loadAllEntries(String fileNameWithPath, CorrectionForm correctionForm) Show all entries for Manual edit with groupId and persist these entries to the DB The restricted functionality mode flag MUST BE SET PRIOR TO CALLING this method.
org.apache.struts.action.ActionForward	loadGroup(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Called when Load Group button is pressed
protected void	loadPersistedInputGroup(CorrectionForm correctionForm) Show all entries for Manual edit with groupId and persist these entries to the DB
protected void	loadPersistedOutputGroup(CorrectionForm correctionForm, boolean setSequentialIds) Retrieves the output origin entries that were saved by the #persistOriginEntryGroupsForDocumentSave(CorrectionForm) method
org.apache.struts.action.ActionForward	manualEdit(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected boolean	prepareForRoute(CorrectionForm correctionForm) Prepare for routing.
protected void	printChangeGroups(GeneralLedgerCorrectionProcessDocument doc)
org.apache.struts.action.ActionForward	removeCorrectionChange(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Remove a correction change from a group
org.apache.struts.action.ActionForward	removeCorrectionCriteria(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Remove a correction criteria from a group
org.apache.struts.action.ActionForward	removeCorrectionGroup(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Remove a correction group
protected void	removeNonMatchingEntries(Collection<OriginEntryFull> entries, Collection<CorrectionChangeGroup> groups)
protected boolean	restoreInputGroupSelectionForDatabaseEdits(CorrectionForm correctionForm) For database-based edits, this method will determine if the input group has been changed since the last time the page was rendered.
protected boolean	restoreSystemAndEditMethod(CorrectionForm correctionForm) This method restores the system and edit method to the selected values when the last call to the selectSystemAndMethod action was made
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) Route the document
org.apache.struts.action.ActionForward	save(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Save the document when they click the save button
org.apache.struts.action.ActionForward	saveManualEntry(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Save a changed row in the group
org.apache.struts.action.ActionForward	saveToDesktop(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Called when copy group to desktop is selected
org.apache.struts.action.ActionForward	searchCancelForManualEdit(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	searchForManualEdit(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	selectSystemEditMethod(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Called when selecting the system and method.
org.apache.struts.action.ActionForward	showOutputGroup(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Toggle the show output/input flag and dataset
org.apache.struts.action.ActionForward	sort(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	sortForDisplay(List groups) Sort CorrectionGroups and their search criteria and replacement specifications so they display properly on the page.
protected void	sortList(List<OriginEntryFull> list, String propertyToSortName, Comparator valueComparator, boolean sortDescending)
org.apache.struts.action.ActionForward	superExecute(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	superSave(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	switchToPage(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	updateDocumentSummary(GeneralLedgerCorrectionProcessDocument document, List<OriginEntryFull> entries, boolean clearOutSummary) This method updates the summary information contained within each document depending on the document status, editing method, whether only the rows matching criteria are shown, and whether the output is being shown If the form is in restricted functionality mode (and the override param is not set to true), then the summaries will be cleared out
protected void	updateEntriesFromCriteria(CorrectionForm correctionForm, boolean clearOutSummary)
org.apache.struts.action.ActionForward	uploadFile(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected boolean	validChangeGroups(CorrectionForm form) Validate all the correction groups
protected boolean	validGroupsItemsForDocumentSave(CorrectionForm correctionForm)
protected boolean	validOriginEntry(CorrectionForm correctionForm)

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

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

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

addMethodToCallToUncheckedList, defaultDispatch, dispatchMethod, findMethodToCall, getApplicationBaseUrl, getBasePath, getEncryptionService, getHeaderTabDispatch, getHeaderTabNavigateTo, getImageContext, getKualiModuleService, getLineToDelete, getReturnLocation, getRoleQualification, getSelectedLine, getTabToToggle, headerTab, performInquiry, performLookup, performQuestionWithInput, performQuestionWithInputAgainBecauseOfErrors, performQuestionWithoutInput, performWorkgroupLookup, postTextAreaToParent, retrieveLookupParameterValue, updateTextArea, validateLookupInquiryFullParameter

Methods inherited from class org.apache.struts.actions.DispatchAction

cancelled, getMethod, getMethodName, getParameter, unspecified

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

addErrors, addMessages, execute, generateToken, getDataSource, getDataSource, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

protected static org.apache.log4j.Logger LOG

originEntryGroupService

protected static OriginEntryGroupService originEntryGroupService

originEntryService

protected static OriginEntryService originEntryService

dateTimeService

protected static org.kuali.rice.kns.service.DateTimeService dateTimeService

kualiConfigurationService

protected static org.kuali.rice.kns.service.KualiConfigurationService kualiConfigurationService

SYSTEM_AND_EDIT_METHOD_ERROR_KEY

public static final String SYSTEM_AND_EDIT_METHOD_ERROR_KEY

See Also:

Constant Field Values

Constructor Detail

CorrectionAction

public CorrectionAction()

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

Overrides:

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

Throws:

Exception

save

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

Save the document when they click the save button

Overrides:

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

Throws:

Exception

close

public org.apache.struts.action.ActionForward close(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 needs to be done just in case they decide to save it when closing.

Overrides:

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

Throws:

Exception

See Also:

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

prepareForRoute

protected boolean prepareForRoute(CorrectionForm correctionForm)
                           throws Exception

Prepare for routing. Return true if we're good to route, false if not

Parameters:

correctionForm -

Returns:

Throws:

Exception

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 org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase

Throws:

Exception

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

Route the document

Overrides:

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

Throws:

Exception

manualEdit

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

docHandler

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

Called when the document is loaded from action list or doc search or a new document is created.

Overrides:

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

Throws:

Exception

See Also:

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

selectSystemEditMethod

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

Called when selecting the system and method. If this button is pressed, the document should be reset as if it is the first time it was pressed.

Throws:

Exception

saveToDesktop

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

Called when copy group to desktop is selected

Throws:

IOException

buildTextOutputfile

public void buildTextOutputfile(ByteArrayOutputStream bw,
                                BufferedReader br)

loadGroup

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

Called when Load Group button is pressed

Throws:

Exception

confirmDeleteDocument

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

Called when a group is selected to be deleted

Throws:

Exception

uploadFile

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

Throws:

FileNotFoundException

IOException

Exception

addCorrectionGroup

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

Throws:

Exception

removeCorrectionGroup

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

Remove a correction group

Throws:

Exception

addCorrectionCriteria

public org.apache.struts.action.ActionForward addCorrectionCriteria(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 correction criteria to the specified group

Throws:

Exception

removeCorrectionCriteria

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

Remove a correction criteria from a group

Throws:

Exception

removeCorrectionChange

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

Remove a correction change from a group

Throws:

Exception

addCorrectionChange

public org.apache.struts.action.ActionForward addCorrectionChange(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 correction change to the specified group

Throws:

Exception

addManualEntry

public org.apache.struts.action.ActionForward addManualEntry(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 row to the group

Throws:

Exception

deleteManualEntry

public org.apache.struts.action.ActionForward deleteManualEntry(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 a row from the group

Throws:

Exception

editManualEntry

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

Edit a row in the group

Throws:

Exception

saveManualEntry

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

Save a changed row in the group

Throws:

Exception

showOutputGroup

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

Toggle the show output/input flag and dataset

Throws:

Exception

searchForManualEdit

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

searchCancelForManualEdit

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

validOriginEntry

protected boolean validOriginEntry(CorrectionForm correctionForm)

loadAllEntries

protected void loadAllEntries(String fileNameWithPath,
                              CorrectionForm correctionForm)

Show all entries for Manual edit with groupId and persist these entries to the DB The restricted functionality mode flag MUST BE SET PRIOR TO CALLING this method.

Parameters:

groupId -

correctionForm -

Throws:

Exception

loadAllEntries

protected void loadAllEntries(List<OriginEntryFull> searchResults,
                              CorrectionForm correctionForm)
                       throws Exception

Throws:

Exception

loadPersistedInputGroup

protected void loadPersistedInputGroup(CorrectionForm correctionForm)
                                throws Exception

Show all entries for Manual edit with groupId and persist these entries to the DB

Throws:

Exception

loadPersistedOutputGroup

protected void loadPersistedOutputGroup(CorrectionForm correctionForm,
                                        boolean setSequentialIds)
                                 throws Exception

Retrieves the output origin entries that were saved by the #persistOriginEntryGroupsForDocumentSave(CorrectionForm) method

Parameters:

correctionForm -

setSequentialIds - if true and not in restricted functionality mode, a pseudo-entry id will be assigned to each of the elements in the form's allEntries attribute.

Throws:

Exception

checkMainDropdown

protected boolean checkMainDropdown(CorrectionForm errorCorrectionForm)

Validate that choose system and edit method are selected

checkOriginEntryGroupSelection

protected boolean checkOriginEntryGroupSelection(CorrectionForm correctionForm)

This method checks that an origin entry group has been selected; and this method is intended to be used for selecting an origin entry group when using the database method If a group has not been loaded, then an error will be added to the screen

Parameters:

correctionForm -

Returns:

checkOriginEntryGroupSelectionBeforeRouting

protected boolean checkOriginEntryGroupSelectionBeforeRouting(GeneralLedgerCorrectionProcessDocument document)

This method checks that an origin entry group has been selected or uploaded, depending on the system of the document If a group has not been loaded, then an error will be added to the screen

Parameters:

document -

Returns:

validChangeGroups

protected boolean validChangeGroups(CorrectionForm form)

Validate all the correction groups

Parameters:

doc -

Returns:

if valid, return true, false if not

sortForDisplay

protected void sortForDisplay(List groups)

Sort CorrectionGroups and their search criteria and replacement specifications so they display properly on the page.

printChangeGroups

protected void printChangeGroups(GeneralLedgerCorrectionProcessDocument doc)

updateEntriesFromCriteria

protected void updateEntriesFromCriteria(CorrectionForm correctionForm,
                                         boolean clearOutSummary)

applyCriteriaOnEntries

protected void applyCriteriaOnEntries(Collection<OriginEntryFull> entries,
                                      boolean matchCriteriaOnly,
                                      List<CorrectionChangeGroup> changeCriteriaGroups)

For criteria based edits, this method will generate the output group

Parameters:

entries - a Collection of OriginEntryFull BOs, this collection and its elements may be directly modified as a result of this method

matchCriteriaOnly - if true, only those entries that matched the criteria before changes were applied will remain in the collection

changeCriteriaGroups - a list of criteria and change groups.

removeNonMatchingEntries

protected void removeNonMatchingEntries(Collection<OriginEntryFull> entries,
                                        Collection<CorrectionChangeGroup> groups)

switchToPage

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

Specified by:

switchToPage in interface org.kuali.rice.kns.web.struts.action.KualiTableRenderAction

Throws:

Exception

See Also:

org.kuali.rice.kns.web.struts.action.KualiTableAction#switchToPage(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

sort

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

Specified by:

sort in interface org.kuali.rice.kns.web.struts.action.KualiTableRenderAction

Throws:

Exception

See Also:

org.kuali.rice.kns.web.struts.action.KualiTableAction#sort(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

sortList

protected void sortList(List<OriginEntryFull> list,
                        String propertyToSortName,
                        Comparator valueComparator,
                        boolean sortDescending)

applyPagingAndSortingFromPreviousPageView

protected void applyPagingAndSortingFromPreviousPageView(CorrectionForm correctionForm)

restoreSystemAndEditMethod

protected boolean restoreSystemAndEditMethod(CorrectionForm correctionForm)

This method restores the system and edit method to the selected values when the last call to the selectSystemAndMethod action was made

Parameters:

correctionForm -

Returns:

if the system and edit method were changed while not in read only mode and the selectSystemEditMethod method was not being called if true, this is ususally not a good condition

restoreInputGroupSelectionForDatabaseEdits

protected boolean restoreInputGroupSelectionForDatabaseEdits(CorrectionForm correctionForm)

For database-based edits, this method will determine if the input group has been changed since the last time the page was rendered.

Parameters:

correctionForm -

Returns:

false if the input group was inappropriately changed without using the selectSystemEditMethod method

updateDocumentSummary

protected void updateDocumentSummary(GeneralLedgerCorrectionProcessDocument document,
                                     List<OriginEntryFull> entries,
                                     boolean clearOutSummary)

This method updates the summary information contained within each document depending on the document status, editing method, whether only the rows matching criteria are shown, and whether the output is being shown If the form is in restricted functionality mode (and the override param is not set to true), then the summaries will be cleared out

Parameters:

document - the document

entries - the entries to summarize

clearOutSummary - whether to set the doc summary to 0s

checkRestrictedFunctionalityModeForManualEdit

protected boolean checkRestrictedFunctionalityModeForManualEdit(CorrectionForm correctionForm)

This method puts an error in the error map indicating that manual edit-ing GLCP docs may not be in restrictedFunctionalityMode, if appropriate (Since we can't view results in this mode, we can't manually edit them)

Parameters:

correctionForm -

Returns:

true if we are not in restricted functionality mode or we are not manual editing

validGroupsItemsForDocumentSave

protected boolean validGroupsItemsForDocumentSave(CorrectionForm correctionForm)

checkInputGroupPersistedForDocumentSave

protected boolean checkInputGroupPersistedForDocumentSave(CorrectionForm correctionForm)

Checks whether this document has the input group still persisted in the database. If the document is in the initiated state, then it'll check whether the group exists in the originEntryGroupService. Otherwise, it'll check whether the group is persisted in the correctionDocumentService.

Parameters:

correctionForm -

Returns:

getMaxEntryId

protected int getMaxEntryId(List<OriginEntryFull> entryList)

superExecute

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

superSave

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