org.kuali.kfs.module.ec.document.web.struts
Class CertificationReportAction

java.lang.Object
  org.apache.struts.action.Action
      org.apache.struts.actions.DispatchAction
          org.kuali.rice.kns.web.struts.action.KualiAction
              org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase
                  org.kuali.rice.kns.web.struts.action.KualiTransactionalDocumentActionBase
                      org.kuali.kfs.sys.document.web.struts.FinancialSystemTransactionalDocumentActionBase
                          org.kuali.kfs.module.ec.document.web.struts.EffortCertificationAction
                              org.kuali.kfs.module.ec.document.web.struts.CertificationReportAction

public class CertificationReportAction
extends EffortCertificationAction

This class handles Actions for EffortCertification document approval.

Field Summary

protected static org.apache.log4j.Logger

LOG

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

DOCUMENT_LOAD_COMMANDS

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

FORM_ACTION, FORWARD_NEXT, FORWARD_TEXT_AREA_UPDATE, METHOD_TO_CALL, POST_TEXT_AREA_TO_PARENT, TEXT_AREA_FIELD_ANCHOR, TEXT_AREA_FIELD_LABEL, TEXT_AREA_FIELD_NAME, TEXT_AREA_MAX_LENGTH, TEXT_AREA_READ_ONLY

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

clazz, log, messages, methods, types

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

defaultLocale, servlet

Constructor Summary

CertificationReportAction()

Method Summary

org.apache.struts.action.ActionForward	add(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) add New Effort Certification Detail Lines
org.apache.struts.action.ActionForward	addSummarizedDetailLine(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 detail line and make a corresponding update on the underlying detail lines
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)
protected Map<String,String>	convertSummarizedDetailToChartAccountMap(List<EffortCertificationDetail> summaryDetail) Transforms the summarized effort detail lines into a chart/account number map
protected List<EffortCertificationDetail>	createSummarizedDetailLines(CertificationReportForm certificationReportForm)
org.apache.struts.action.ActionForward	delete(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) delete detail line
org.apache.struts.action.ActionForward	deleteSummarizedDetailLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) delete a detail line from summarized detail lines and make a corresponding update on the underlying detail lines
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 List<EffortCertificationDetail>	findDetailLinesInGroup(List<EffortCertificationDetail> detailLines, String groupId) find the detail lines belonging to the given group from the given detail lines
protected String	getPropsalNumberForProjectDirector(String projectDirectorId, List<EffortCertificationDetail> summarizedDetailLines) Retrieves a proposal number for a project director from a list of awards pulled by chart/account number.
org.apache.struts.action.ActionForward	insertBONote(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected boolean	isSummarizeDetailLinesRendered(CertificationReportForm certificationReportForm) determine whether the summarized detail lines need to be rendered
protected void	loadDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase kualiDocumentFormBase)
protected void	populateAuthorizationFields(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase formBase) Do one additional check on Use Transactional for Summary Tab
org.apache.struts.action.ActionForward	recalculate(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) recalculate the detail line
protected void	recalculateAllDetailLines(CertificationReportForm certificationReportForm) recalculate all detail lines with the information in summarized detail lines
org.apache.struts.action.ActionForward	recalculateSummarizedDetailLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) recalculate a detail line in summarized detail lines and make a corresponding update on the underlying detail lines
org.apache.struts.action.ActionForward	refresh(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected Map<String,DetailLineGroup>	refreshDetailLineGroupMap(CertificationReportForm certificationReportForm) rebuild the detail line group map from the detail lines of the current document
protected void	resetPersistedFields(EffortCertificationDetail detailLine) reset the persisted fields of the given detail line
org.apache.struts.action.ActionForward	revert(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) revert the detail line to the original values
protected void	revertDetaiLine(List<EffortCertificationDetail> detailLines, EffortCertificationDetail lineToRevert) find the given detail line from the given collection of detail lines and revert it
protected void	revertDetaiLine(List<EffortCertificationDetail> detailLines, int lineToRevertIndex) revert the detail line in the specified position
org.apache.struts.action.ActionForward	revertSummarizedDetailLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) revert a detail line in summarized detail lines and make a corresponding update on the underlying detail lines
protected void	sortDetailLine(CertificationReportForm certificationReportForm, List<EffortCertificationDetail> detailLines, String... sortColumn) sort the detail lines based on the values of the sort order and sort column
org.apache.struts.action.ActionForward	sortDetailLineByColumn(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) sort the detail lines by column
protected void	toggleSortOrder(CertificationReportForm certificationReportForm) Toggles the sort order between ascending and descending.
protected void	updateDetailLineGroup(DetailLineGroup detailLineGroup, EffortCertificationDetail detailLine, org.kuali.rice.kns.util.KualiDecimal totalPayrollAmount) update detail line group with the the information in the given detail line
protected void	updateDetailLinesFromSummaryLines(CertificationReportForm certificationReportForm) recalculate all detail lines with the information in summarized detail lines

Methods inherited from class org.kuali.kfs.module.ec.document.web.struts.EffortCertificationAction

invokeRules, processDetailLineOverrides, updateDetailLineOverrideCode

Methods inherited from class org.kuali.kfs.sys.document.web.struts.FinancialSystemTransactionalDocumentActionBase

correct

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

copy

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

acknowledge, attemptLockRelease, blanketApprove, buildAuthorizationException, cancel, cancelBOAttachment, canSave, checkAndWarnAboutSensitiveData, checkAuthorization, close, combineAdHocRecipients, convertSetToMap, createDocument, deleteAdHocRoutePerson, deleteAdHocRouteWorkgroup, deleteBONote, determineNoteWorkflowNotificationAction, disapprove, docHandler, doProcessingAfterPost, downloadBOAttachment, 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, route, save, selectedAttachmentIndex, sendAdHocRequests, sendNoteWorkflowNotification, setupDocumentExit, setupPessimisticLockMessages, showAllTabs, streamToResponse, supervisorFunctions, toggleTab

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

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

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

cancelled, getMethod, getMethodName, getParameter, unspecified

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

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

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static org.apache.log4j.Logger LOG

Constructor Detail

CertificationReportAction

public CertificationReportAction()

Method Detail

recalculate

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

recalculate the detail line

Throws:

Exception

add

public org.apache.struts.action.ActionForward add(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 New Effort Certification Detail Lines

Throws:

Exception

delete

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

Overrides:

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

Throws:

Exception

revert

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

revert the detail line to the original values

Throws:

Exception

loadDocument

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

Overrides:

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

Throws:

org.kuali.rice.kew.exception.WorkflowException

See Also:

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

refresh

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

Overrides:

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

Throws:

Exception

See Also:

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

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

See Also:

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

sortDetailLineByColumn

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

sort the detail lines by column

Throws:

Exception

recalculateSummarizedDetailLine

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

recalculate a detail line in summarized detail lines and make a corresponding update on the underlying detail lines

Throws:

Exception

addSummarizedDetailLine

public org.apache.struts.action.ActionForward addSummarizedDetailLine(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 detail line and make a corresponding update on the underlying detail lines

Throws:

Exception

deleteSummarizedDetailLine

public org.apache.struts.action.ActionForward deleteSummarizedDetailLine(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 detail line from summarized detail lines and make a corresponding update on the underlying detail lines

Throws:

Exception

revertSummarizedDetailLine

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

revert a detail line in summarized detail lines and make a corresponding update on the underlying detail lines

Throws:

Exception

findDetailLinesInGroup

protected List<EffortCertificationDetail> findDetailLinesInGroup(List<EffortCertificationDetail> detailLines,
                                                                 String groupId)

find the detail lines belonging to the given group from the given detail lines

Parameters:

detailLines - the given detail lines

groupId - the given group id

Returns:

the detail lines belonging to the given group

isSummarizeDetailLinesRendered

protected boolean isSummarizeDetailLinesRendered(CertificationReportForm certificationReportForm)

determine whether the summarized detail lines need to be rendered

Parameters:

certificationReportForm - the action form

Returns:

true if the summarized detail lines need to be rendered; otherwise, false

recalculateAllDetailLines

protected void recalculateAllDetailLines(CertificationReportForm certificationReportForm)

recalculate all detail lines with the information in summarized detail lines

Parameters:

certificationReportForm - the given action form

updateDetailLinesFromSummaryLines

protected void updateDetailLinesFromSummaryLines(CertificationReportForm certificationReportForm)

recalculate all detail lines with the information in summarized detail lines

Parameters:

certificationReportForm - the given action form

updateDetailLineGroup

protected void updateDetailLineGroup(DetailLineGroup detailLineGroup,
                                     EffortCertificationDetail detailLine,
                                     org.kuali.rice.kns.util.KualiDecimal totalPayrollAmount)

update detail line group with the the information in the given detail line

Parameters:

detailLineGroup - the given detail line group

detailLine - the given detail line

totalPayrollAmount - the total payroll amount of the document associating with the detail line group

toggleSortOrder

protected void toggleSortOrder(CertificationReportForm certificationReportForm)

Toggles the sort order between ascending and descending. If the current order is ascending, then the sort order will be set to descending, and vice versa.

sortDetailLine

protected void sortDetailLine(CertificationReportForm certificationReportForm,
                              List<EffortCertificationDetail> detailLines,
                              String... sortColumn)

sort the detail lines based on the values of the sort order and sort column

refreshDetailLineGroupMap

protected Map<String,DetailLineGroup> refreshDetailLineGroupMap(CertificationReportForm certificationReportForm)

rebuild the detail line group map from the detail lines of the current document

revertDetaiLine

protected void revertDetaiLine(List<EffortCertificationDetail> detailLines,
                               EffortCertificationDetail lineToRevert)

find the given detail line from the given collection of detail lines and revert it

revertDetaiLine

protected void revertDetaiLine(List<EffortCertificationDetail> detailLines,
                               int lineToRevertIndex)

revert the detail line in the specified position

resetPersistedFields

protected void resetPersistedFields(EffortCertificationDetail detailLine)

reset the persisted fields of the given detail line

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:

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

Throws:

Exception

See Also:

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

insertBONote

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

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

Throws:

Exception

See Also:

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

populateAuthorizationFields

protected void populateAuthorizationFields(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase formBase)

Do one additional check on Use Transactional for Summary Tab

Overrides:

populateAuthorizationFields in class org.kuali.rice.kns.web.struts.action.KualiTransactionalDocumentActionBase

See Also:

KualiTransactionalDocumentActionBase.populateAuthorizationFields(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase)

getPropsalNumberForProjectDirector

protected String getPropsalNumberForProjectDirector(String projectDirectorId,
                                                    List<EffortCertificationDetail> summarizedDetailLines)

Retrieves a proposal number for a project director from a list of awards pulled by chart/account number.

Parameters:

projectDirectorId -

Returns:

createSummarizedDetailLines

protected List<EffortCertificationDetail> createSummarizedDetailLines(CertificationReportForm certificationReportForm)

convertSummarizedDetailToChartAccountMap

protected Map<String,String> convertSummarizedDetailToChartAccountMap(List<EffortCertificationDetail> summaryDetail)

Transforms the summarized effort detail lines into a chart/account number map

Parameters:

summaryDetail -

Returns: